configdir

Return a directory for user-specific configuration files.

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 an APPDATA 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' ) );

CLI

Usage

Usage: configdir [options]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ configdir
e.g., /Users/<username>/Library/Preferences