Figg

A simple utility for managing YAML configuration files. Also supports JSON.

Install

NPM:

$ npm install figg

Yarn:

$ yarn add figg

Usage

const Figg = require('figg')
const config = new Figg()
 
// Add a single property
config.set('name', 'John Div')
 
// Add multiple properties
config.set({
  description: 'A stylish web designer',
  url: 'http://johndiv.cool',
  stylish: true
})
 
// Get a property
console.log(config.get('name'))
// 'John Div'
 
// Save config file (config.yml by default)
config.save()
 
// Load existing config file as an object
let myConfig = config.load()

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 = new Figg()

In this example, Figg will load/save your config at ./app/settings.json.

const config = new Figg({
  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