@delta-framework/config-builder

1.0.0-alpha.3 • Public • Published

delta-framework/config-builder

Config builder

Delta framework base library License
NPM version Downloads Build Status

npm install @delta-framework/config-builder@latest

Summary

This is a library creating a typed object based on the delta.json file in the project.
The delta.json file is parsed, autofilled with package variables and transformed with delta.{environment}.json
This provides a way to easily access these config's in code.

Default config builder properties

The delta.json file can contain any extended model, however default properties contain:

  • debug:
    boolean flag to determine whether or not this is debugging context.
  • startPath:
    The path of the delta application startup class
  • packageVersion:
    The version specified in the package.json
  • packageName:
    The name specified in the package.json
  • environmentName:
    The current environment name defined by passing "environment: {environment}" to the process.argv.
    Defaults to "development".

Usage

import { DeltaConfigBuilder, DeltaConfigBase } from '@delta-config/config-builder';

// ...

const configuration = (new DeltaConfigBuilder).buildConfig<DeltaConfigBase>();

Contributing

See the Contribution guide for help about contributing to this project.

Changelog

See the Changelog to see the change history.

Readme

Keywords

Package Sidebar

Install

npm i @delta-framework/config-builder

Weekly Downloads

0

Version

1.0.0-alpha.3

License

Apache-2.0

Unpacked Size

105 kB

Total Files

61

Last publish

Collaborators

  • marvin-brouwer