@stdlib/process/chdir/docs/types/index.d.ts

Process utilities.

/*
* @license Apache-2.0
*
* Copyright (c) 2019 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/**
* Changes the current working directory.
*
* ## Notes
*
* -   If unable to set the current working directory (e.g., due to a non-existent path), the function returns an error; otherwise, the function returns `null`.
*
* @param path - desired working directory
* @returns error object or `null`
*
* @example
* var err = chdir( __dirname );
* if ( err ) {
*     throw err;
* }
*/
declare function chdir( path: string ): Error | null;


// EXPORTS //

export = chdir;