https://github.com/stdlib-js/os-configdir
Return a directory for user-specific configuration files.
https://github.com/stdlib-js/os-configdir
conf config configdir confighome darwin dir directory javascript linux mac node node-js nodejs os stdlib user util utilities utils windows
Last synced: 5 months ago
JSON representation
Return a directory for user-specific configuration files.
- Host: GitHub
- URL: https://github.com/stdlib-js/os-configdir
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-13T19:28:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-24T03:18:28.000Z (8 months ago)
- Last Synced: 2025-05-13T02:12:37.155Z (5 months ago)
- Topics: conf, config, configdir, confighome, darwin, dir, directory, javascript, linux, mac, node, node-js, nodejs, os, stdlib, user, util, utilities, utils, windows
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.07 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return a directory for user-specific configuration files.
## Installation
```bash
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][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
- To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.
The [branches.md][branches-url] 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
```javascript
var configdir = require( '@stdlib/os-configdir' );
```
#### configdir( \[path] )
Returns a directory for user-specific configuration files.
```javascript
var dir = configdir();
// e.g., returns '/Users//Library/Preferences'
```
To append a `path` to the base directory, provide a `path` argument.
```javascript
var dir = configdir( 'appname/config' );
// e.g., returns '/Users//Library/Preferences/appname/config'
```
On non-Windows platforms, if the function is unable to locate the current user's [`home`][@stdlib/os/homedir] 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][environment-variable-windows] before checking for an `APPDATA` [environment variable][environment-variable-windows]. This means that machine specific user configuration files have precedence over roaming user configuration files.
## Examples
```javascript
var configdir = require( '@stdlib/os-configdir' );
console.log( configdir( 'appy/config' ) );
```
* * *
## CLI
## Installation
To use as a general utility, install the CLI package globally
```bash
npm install -g @stdlib/os-configdir-cli
```
### Usage
```text
Usage: configdir [options]
Options:
-h, --help Print this message.
-V, --version Print the package version.
```
### Examples
```bash
$ configdir
e.g., /Users//Library/Preferences
```
* * *
## See Also
- [`@stdlib/os-homedir`][@stdlib/os/homedir]: return the current user's home directory.
- [`@stdlib/os-tmpdir`][@stdlib/os/tmpdir]: return the directory for storing temporary files.
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/os-configdir.svg
[npm-url]: https://npmjs.org/package/@stdlib/os-configdir
[test-image]: https://github.com/stdlib-js/os-configdir/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/os-configdir/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/os-configdir/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/os-configdir?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[cli-section]: https://github.com/stdlib-js/os-configdir#cli
[cli-url]: https://github.com/stdlib-js/os-configdir/tree/cli
[@stdlib/os-configdir]: https://github.com/stdlib-js/os-configdir/tree/main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/os-configdir/tree/deno
[deno-readme]: https://github.com/stdlib-js/os-configdir/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/os-configdir/tree/umd
[umd-readme]: https://github.com/stdlib-js/os-configdir/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/os-configdir/tree/esm
[esm-readme]: https://github.com/stdlib-js/os-configdir/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/os-configdir/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/os-configdir/main/LICENSE
[environment-variable-windows]: https://en.wikipedia.org/wiki/Environment_variable#Windows
[@stdlib/os/homedir]: https://github.com/stdlib-js/os-homedir
[@stdlib/os/tmpdir]: https://github.com/stdlib-js/os-tmpdir