Toki-Config

Loads configuration and returns it as an object

This is the configuration loading device for Toki. It loads a Toki configuration from a configuration loading submodule which must be specified at instantiation. Click here to view currently available configuration loaders.

Lead Maintainer: Rob Horrigan

Getting Started

Setup will depend on which configuration loading submodule you want to use. In general, you will need to define your configuration to fit the Toki Configuration Schema and use a configuration loading submodule to return an object meeting that specification to toki-config.

Currently Available Configuration Loaders

1. toki-config-file - Loads configuration from static file

• See example here.

How to specify which Configuration Loader you want to use

Toki-Config requires configuration options to be passed at time of instantiation. This object must specify the name of the submodule to use to load the configuration and any options you wish to pass to the submodule.

const options = {
    'name-of-submodule': {
        foo: 'bar'
    }
}

Development Setup

Install Dependencies

Install the dependencies based on package.json.

make install

Test Project

Run tests locally.

make test