forst

v1.0.2
Radix Trie-Based Configuration Platform
trie radix configuration tree

# ![forst](media/logo-01.png)

Radix Trie Hierarchical Configurations

Build Status: Linux Standard Version Conventional Commits

Setup

Add Forst as a dependency

$ npm install --save forst

Create a folder in which your config tree(s) will live

Example

$ mkdir conf

Usage

Consider the following config tree directory

/conf/
├── foo
│   └── bar
│       └── baz.json
├── test
│   ├── bar.json
│   └── foo.json -> { "enabled": false }
└── test.json -> { "enabled": true, "name": "foo" }

Getting the base configuration:

const forst = require('forst');

forst('test', './conf').then(config => console.log(config));

console.log(config); // { "enabled": true, "name": "foo" }

Getting the nested configuration:

const forst = require('forst');

forst(['test', 'test/foo'], './conf').then(config => console.log(config));

console.log(config); // { "enabled": false,  "name": "foo" }

If the config file is not found it will return either the values of the parent configuration if found or an empty object if nothing is found.

API

Table of Contents

index

forst

Parameters

map

forstMap

Parameters

Sponsors

The ideas and initial development of this project (formerly known as mwconf) has been sponsored by Mindfulware, a Software Development Company.

Mindfulware: Integrity, Performance, Design

Metadata

  • MIT
  • Whatever
  • Michael Price
  • released 10/22/2018

Downloads

Maintainers