ConfigSourceOptions

@tsed/config

Usage

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

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

Overview

interface ConfigSourceOptions<Opts = any> {
    name?: string;
    priority?: number;
    enabled?: boolean;
    use: Type<ConfigSource<Opts>>;
    options: Opts;
    validationSchema?: JsonSchema;
    watch?: boolean;
    refreshOn?: "request" | "response";
}

name

name?: string;

The name of the configuration provider.

priority

priority?: number;

The priority of the configuration provider. Higher priority providers will override values from lower priority providers.

enabled

enabled?: boolean;

Whether to enable the configuration provider.

use

use: Type<ConfigSource<Opts>>;

The ConfigSource to use for loading configuration values.

options

options: Opts;

Options for the configuration provider.

validationSchema

validationSchema?: JsonSchema;

The schema to validate the configuration values against.

watch

watch?: boolean;

Enable FileSystem Watch mode. ConfigSource must implement the watch() method.

refreshOn

refreshOn?: "request" | "response";

Refresh strategy. Ts.ED can refresh ConfigSource during the "$onRequest" or "$onResponse" hook.

Note: refresh data during $onRequest can degrade performance depending on the ConfigSource type. We recommend to refresh data during the $onResponse hook (action are asynchronous).