ConfigSource

@tsed/config

Usage

import { ConfigSource } from "@tsed/config";

See /packages/config/src/types/interfaces/ConfigSource.ts.

Overview

interface ConfigSource<Opts = any> {
    options: Opts;
    $onInit?(): Promise<void> | void;
    $onDestroy?(): Promise<void> | void;
    getAll(): Promise<Record<string, unknown>> | Record<string, unknown>;
    watch?(onChange?: ConfigSourceOnChangeCB): Promise<ConfigSourceWatchCloseCB> | ConfigSourceWatchCloseCB | void | Promise<void>;
}

Description

Interface for a configuration source that can provide configuration values.

options

options: Opts;

$onInit

$onInit?(): Promise<void> | void;

$onDestroy

$onDestroy?(): Promise<void> | void;

getAll

getAll(): Promise<Record<string, unknown>> | Record<string, unknown>;

Load configuration from the source.

watch

watch?(onChange?: ConfigSourceOnChangeCB): Promise<ConfigSourceWatchCloseCB> | ConfigSourceWatchCloseCB | void | Promise<void>;