https://github.com/dimkl/config

Create configuration class from env or other resources
https://github.com/dimkl/config

Last synced: about 1 year ago
JSON representation

Create configuration class from env or other resources

• Host: GitHub
• URL: https://github.com/dimkl/config
• Owner: dimkl
• License: mit
• Created: 2023-05-02T21:58:18.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-06T21:58:23.000Z (over 2 years ago)
• Last Synced: 2024-10-06T03:20:18.866Z (over 1 year ago)
• Language: TypeScript
• Size: 82 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Config

`@dimkl/condig` is a **dependency-free** JS library for initialization a configuration instance or class.

## Installation

Use the package manager [npm](https://nodejs.org/en/download/) to install `@dimkl/config`

```bash

npm install @dimkl/config

```

## Requirements & limitations

- node >= 18.17

- typescript decorators support enabled in tsconfig using `"experimentalDecorators": true`

## Usage

Examples can be found in `examples/` folder.

## Testing

[![codecov](https://codecov.io/gh/dimkl/config/branch/main/graph/badge.svg?token=VHYWTFBNHB)](https://codecov.io/gh/dimkl/config)

### Run tests

```

npm test

```

## Support

For feature request or issues contact me via [email](mailto:dimitris.klouvas@gmail.com) or open an issue in repo

## Publish

```

npm version {patch|minor|major}

npm publish

```

## Roadmap

TODO

## Contributing

Pull requests are welcome. For major changes, please open an issue first

to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)