@dworac/config

This is an environment variables helper for typescript. It helps type and validate environment variables. It read the environment variables from the .env file and from the process.env object.

Installation

yarn add @dworac/config

Usage

import { ConfigVariable } from '@dworac/config';

class Config {
  @ConfigVariable(String, "defaultValue")
  STRING_VAR!: string;

  @ConfigVariable(Number, 0)
  NUMBER_VAR!: number;

  @ConfigVariable(Boolean, false)
  BOOLEAN_VAR!: boolean;
}

const config = new Config();

console.log(config.STRING_VAR); // "defaultValue"
console.log(config.NUMBER_VAR); // 0
console.log(config.BOOLEAN_VAR); // false

If no default value is provided and no value is found an error will be thrown. This is usefull for non-optional variables.

Development

Make sure to add the necessary unit tests before submitting a pull request.

In order to install packages run:

yarn

For running in dev mode:

yarn start:dev

For running tests:

yarn test

For running linting

yarn lint

Contributing

If you have any suggestions or improvements, please feel free to create a pull request or submit an issue.

License

This project is licensed under the MIT license. Please see the LICENSE file for more information.