@stdlib/os-configdir
v0.2.2
Published
Return a directory for user-specific configuration files.
Downloads
15
Readme
configdir
Return a directory for user-specific configuration files.
Installation
npm install @stdlib/os-configdir
Usage
var configdir = require( '@stdlib/os-configdir' );
configdir( [path] )
Returns a directory for user-specific configuration files.
var dir = configdir();
// e.g., returns '/Users/<username>/Library/Preferences'
To append a path
to the base directory, provide a path
argument.
var dir = configdir( 'appname/config' );
// e.g., returns '/Users/<username>/Library/Preferences/appname/config'
On non-Windows platforms, if the function is unable to locate the current user's home
directory, the function returns null
. Similarly, on Windows platforms, if the function is unable to locate an application data directory, the function also returns null
.
Notes
- On Windows platforms, the function first checks for a
LOCALAPPDATA
environment variable before checking for anAPPDATA
environment variable. This means that machine specific user configuration files have precedence over roaming user configuration files.
Examples
var configdir = require( '@stdlib/os-configdir' );
console.log( configdir( 'appy/config' ) );
See Also
@stdlib/os-configdir-cli
: CLI package for use as a command-line utility.@stdlib/os-homedir
: return the current user's home directory.@stdlib/os-tmpdir
: return the directory for storing temporary files.
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.