Introduction to providers

Provider is an object responsible for loading config value from any source like env variables, files or external services.

Provider can retrieve values in synchronous or asynchronous way. Some providers can behave like hybrids that use sync or async approach depending on additional conditions. Example of such provider is transform provider that takes provided provider (sync or async) then resolves value in the same way as injected provider.

@pallad/config supports retrieving values from:

• Environment variables
• ENV files
• TOML files
• AWS SSM Parameter Store
• AWS Secret Manager

If you need to load values from different source you can define your own custom provider.

For usability purposes @pallad/config has few composable providers:

• Default value
• Transform
• Pick by type
• First available
• Default with transformer

Custom provider

For example purposes lets create a new provider that retrieves data from an object.

Every provider must extends common Provider, otherwise we will not be able to detect it during loading.

import {Provider, ValueNotAvailable} from '@pallad/config';
import {left, right} from '@sweet-monads/either';

const VALUES = {
    FOO: 'bar',
    BAZ: 'world'
}

export class CustomProvider extends Provider {
    constructor(key) {
        super();
        this.key = key;
    }

    getValue() {
        // if value is available
        if (VALUES[this.key]) {
            // then return it
            return right(VALUES[this.key]);
        }

        // otherwise tells that value is not available along with description
        return left(new ValueNotAvailable(`Custom provider: ${this.key}`));
    }
}

Usage

// resolves to "bar"
new CustomProvider('FOO');

// fails to load
new CustomProvider('UNKNOWN');