Skip to content

Repository files navigation

conev-source-json

conev-source-json is an implementation of conev's source to get configuration from json.

Install

# with npm 
npm install conev-source-json
# or with Yarn 
yarn add conev-source-json

Usage

Get ConfigBuilder from conev and Sources to use.

import{ConfigBuilder}from'conev';importJsonSourcefrom'conev-source-json';

And create Source and set up.

constjsonSource=newJsonSource();jsonSource.setConfig('basic',basic)// basic is JSON.setConfig('dev',dev)// dev is JSON.setConfig('prd',prd);// prd is JSON

Create ConfigBuilder and set Environment, add source. (highest priority is added first).

constbuilder=newConfigBuilder();builder.setEnv('dev','basic').addSource(jsonSource);

Build configuration

constconfig=awaitbuilder.build();// This is the result of combining dev and basic.

Use configuration

config.get()// The whole configuration created comes outconfig.get('a.b.c');// Is same as config.get().a.b.c

Json Source

classJsonSource{constructor(map?: Map<string,object>);setConfig(env: string, ...values: object[]): JsonSourceaddConfig(env: string, ...values: object[]): JsonSource;removeConfig(env: string): JsonSource;export(): Promise<Map<string,object>>;}

JsonSource defines the source from JSON. Use setConfig to add a configuration for a new environment or removeConfig to delete a configuration. Map is returned as the result value of export. The key of this map is environment and the value is the configuration when environment.

About

conev-source-json is an implementation of conev's source to get configuration from json.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages