@qiwi/uniconfig

@qiwi/uniconfig-core

Core uniconfig layer: basic ifaces, utils, entry point, plugin API

Install

  npm i @qiwi/uniconfig-core
  yarn add @qiwi/uniconfig-core

Plugin API

uniconfig features may be significantly extended with plugins.

import uniconfig, {rollupPlugin} from '@qiwi/uniconfig'
import uniconfigPluginYaml from '@qiwi/uniconfig-plugin-yaml'    

rollupPlugin(uniconfigPluginYaml)
const config = uniconfig('./foobar.yml')    

Each plugin must expose at least two methods to be registered: rollup and rollback.

export interface IContext {
  api: any,
  processor: any,
  parser: any,
  source: any
}

export interface IPlugin {
  rollback(context: IContext): void,
  rollup(context: IContext): void
}

Example

{
  "data": {
    "foo": "bar",
    "baz": 1,
    "host": "$remoteConfig.hostname",
    "port": "$jsonFile.defaultPort"
  },
  "source": {
     "jsonFile": {"api": "file", "parser": "json", "target": "./foo.json"},
     "yamlFile": {"api": "file", "parser": "yaml", "target": "./bar.yaml"},
     "remoteConfig": {"api": "http", "parser": "json", "target": "https://reqres.in/api/users/2"}
  }
}