@stdlib/os/homedir/docs/types/index.d.ts

OS 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

/**
* Returns the current user's home directory.
*
* ## Notes
*
* -   If unable to locate a home directory, the function returns `null`.
*
* @returns home directory
*
* @example
* var home = homedir();
* // e.g., returns '/Users/<username>'
*/
declare function homedir(): string | null;


// EXPORTS //

export = homedir;