@stdlib/os/homedir/lib/index.js

OS utilities.

/**
* @license Apache-2.0
*
* Copyright (c) 2018 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.
*/

'use strict';

/**
* Return the current user's home directory.
*
* @module @stdlib/os/homedir
*
* @example
* var homedir = require( '@stdlib/os/homedir' );
* var home = homedir();
* // e.g., returns '/Users/<username>'
*/

// MODULES //

var os = require( 'os' );
var isFunction = require( '@stdlib/assert/is-function' );
var main = require( './main.js' );


// VARIABLES //

var home = ( isFunction( os.homedir ) ) ? os.homedir : main; // eslint-disable-line node/no-unsupported-features/node-builtins


// EXPORTS //

module.exports = home;