Socket
Socket
Sign inDemoInstall

application-config

Package Overview
Dependencies
33
Maintainers
2
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    application-config

Store your applications config where the operating system wants you to.


Version published
Maintainers
2
Install size
416 kB
Created

Readme

Source

Node.js Application Config

Store your applications config where the operating system wants you to.

Installation

npm install --save application-config

Usage

var cfg = require('application-config')('App Name')

// Read the stored data
const data = await cfg.read()

// Write new config
await cfg.write({ n: 1337 })

// Trash the stored config
await cfg.trash()

API

applicationConfig(name)

Creates and return a new instance with the provided name.

cfg.read()

Read the stored configuration. Returns a Promise that settles with the data.

cfg.write(data)

Write new configuration. Returns a Promise.

cfg.trash()

Remove the stored configuration. Returns a Promise.

cfg.filePath

The path to the underlying file in which the configuration is stored.

Config location

PlatformLocation
OS X~/Library/Application Support/<name>/config.json
Linux (XDG)$XDG_CONFIG_HOME/<name>/config.json
Linux (Legacy)~/.config/<name>/config.json
Windows (> Vista)%LOCALAPPDATA%/<name>/config.json
Windows (XP, 2000)%USERPROFILE%/Local Settings/Application Data/<name>/config.json

License

MIT

FAQs

Last updated on 16 Nov 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc