# user-settings

> Simple user settings management

Latest version **0.2.0** (published 2017-11-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install user-settings
pnpm add user-settings
yarn add user-settings
bun add user-settings
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2017-11-11 |
| First published | 2014-05-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | Bruno Daniel |
| Maintainers | rev087 |
| Keywords | settings, config, user-settings, dotfile |

## Links

- npm: https://www.npmjs.com/package/user-settings
- Repository: https://github.com/rev087/user-settings
- Issues: https://github.com/rev087/user-settings/issues
- npm.io page: https://npm.io/package/user-settings

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.2.0 (latest) — 2017-11-11
- 0.1.5 — 2014-05-29
- 0.1.4 — 2014-05-29
- 0.1.3 — 2014-05-26
- 0.1.2 — 2014-05-26

## README

# user-settings

__user-settings__ is a simple way to manage user settings for your command-line Node application. Settings are stored as a file in the user's home directory and all methods are synchronous for simplicity.

## Usage

You specify the filename to store and retrieve

```js
// If ~/.myAppSettings doesn't exist, it's created
var settings = require('user-settings').file('.myAppSettings');

// Storing user settings
settings.set('username', 'rev087');

// Retrieving user settings
var username = settings.get('username');

// Unsetting
settings.unset('username');

```

## Home directory location

The home directory used for Unix systems is `process.env.HOME` and `process.env.USERPROFILE` for Windows.

---
_Source: https://npm.io/package/user-settings · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._