ts-options-defaults

ts-options-defaults

Object.assign({}, defaults, options) and equivalent with destructing {...defaults, ...options} come with a pitfall of creating only a shallow copy. Lodash _.merge works on deep properties, but it merges arrays and that usually makes no sense in the context of default options. This package fixes that problem - it merges objects deeply and overrides arrays. Also result remains strongly typed.

Options-defaults design pattern implementation for reliable configuration.

Usage

npm i ts-options-defaults

import { defaults } from 'ts-options-defaults';

export interface ISomeOptions {
    logger?: Partial<Console>;
    path: string;
}

export class Something {
    static defaults: Required<ISomeOptions> = {
        logger: console,
    };

    constructor(public options: IRatOptions) {
        this.options = defaults({}, Rat.defaults, options);
    }
}