Figg
A simple utility for managing YAML configuration files. Also supports JSON.
Install
NPM:
$ npm install figg
Yarn:
$ yarn add figg
Usage
const Figg = const config = // Add a single propertyconfig // Add multiple propertiesconfig // Get a propertyconsole// 'John Div' // Save config file (config.yml by default)config // Load existing config file as an objectlet myConfig = config
API
Figg([options])
options.name
Type: string
Default: 'config'
Name of the config without the extension
options.extension
Type: string
Default: '.yml'
The file extension used when loading and saving config files. Valid extensions are '.yml'
, '.yaml'
and '.json'
.
options.path
Type: string
Default: Current working directory
Path to the directory where the config file is loaded/saved.
Examples
This example uses the default options. In this case, Figg will load/save your config at ./config.yml
.
const config =
In this example, Figg will load/save your config at ./app/settings.json
.
const config = name: 'settings' extension: '.json' path: './app'
Instance Methods
config.get(key)
Returns the value of key
if it exists.
config.set(key, value)
Add a new property to the config.
config.set(object)
Add multiple properties at once.
config.has(key)
Check if a property exists.
config.load()
Load a config file. Returns an object.
config.save()
Save a config file.
License
MIT © Nick Pfisterer