About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

configdir

Return a directory for user-specific configuration files.

Installation

npm install @stdlib/os-configdir

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).
• To use as a general utility for the command line, install the corresponding CLI package globally.

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

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

Installation

To use as a general utility, install the CLI package globally

npm install -g @stdlib/os-configdir-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

---

See Also

• @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.