Feature: Redesign node-config-ts

[tusharmath]

It's been long, and I think this library needs a re-write :)

Here is the first draft of the proposed design.

Define your config using the following signature. This is better than a pre-build step

import { Schema } from 'node-config-ts'

const schema = Schema.type({
    port: Schema.number,
    maxRetries: Schema.number,
    secret: Schema.optional(Schema.string)
})

Then we create Config Sources. Sources are just a way to read arbitrary data and convert it into a JSON format.

import {Source} from 'node-config-ts'
const yml: Source = Source.json("./default.yml")

We can create any arbitrary source also using the make constructor.

const cli: Source = Source.make(() => minimist.parse(process.args))
const defaults: Source= Source.make(() => ({port: 8090, maxRetries: 20}))

We can merge the sources as follows:

const source = cli.orElse(yml).orElse(defaults)

Once a source is ready we can convert to config using the schema

export const config = source.as(schema)
export type Config = typeof config

In your application you can now use config to access value, and use Config as it's type.

[tusharmath]

Instead of building Schema from scratch, we could also use https://github.com/tusharmath/tts-schema

[mbwhite]

Hi @tusharmath; I've just been looking for a typescript library to handle a more complex configuration; this is one of the first I came across. Looks promising but I missed the typing I had in say env-var. So I like the approach above.

I can assist at all..

[tusharmath]

Perfect! Let me know if you need anything.