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
LOCALAPPDATAenvironment variable before checking for anAPPDATAenvironment 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' ) );
CLI
Installation
To use the module as a general utility, install the module globally
npm install -g @stdlib/os-configdir
Usage
Usage: configdir [options]
Options:
-h, --help Print this message.
-V, --version Print the package version.
Examples
$ configdir
e.g., /Users/<username>/Library/Preferences
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-2022. The Stdlib Authors.