readsettings
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

ReadSettings Travis CI Build Status

Easily manage a configuration file for your application.

NPM Badge

Install

npm install readsettings

Usage

const ReadSettings = require("readsettings");
 
const config = new ReadSettings("myConfig.json");
 
config.data;
//=> {}
 
config.data.someKey = "Hello World!";
 
config.data;
//=> {somekey: "Hello World!"}

API

class ReadSettings(dir, options?)

dir

Type: string

The directory to store the settings file.

options

Type: Conf.Options<any>

Custom options to pass to conf.

instance ReadSettings extends Conf

data

Type: object

The currently stored data.

Package Sidebar

Install

npm i readsettings

Weekly Downloads

3

Version

1.0.1

License

MIT

Unpacked Size

6.5 kB

Total Files

11

Last publish

Collaborators

  • richienb