withOptions

@tsed/config

Usage

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

See /packages/config/core/src/utils/withOptions.ts.

Overview

function withOptions<Opts>(use: Type<ConfigSource<Opts>>, { name, priority, validationSchema, enabled, refreshOn, watch, ...opts }: InitialConfigSourceOptions & Opts): {
    name: string | undefined;
    priority: number | undefined;
    validationSchema: {
        toJSON(opts: Record<string, unknown>): Record<string, unknown> & {
            required?: string[];
        };
    } | undefined;
    use: Type<ConfigSource<Opts>>;
    watch: boolean | undefined;
    refreshOn: "request" | "response" | undefined;
    enabled: boolean;
    options: Omit<InitialConfigSourceOptions & Opts, "name" | "priority" | "enabled" | "validationSchema" | "watch" | "refreshOn">;
};

name

name: string | undefined;

priority

priority: number | undefined;

validationSchema

validationSchema: {
     toJSON(opts: Record<string, unknown>): Record<string, unknown> & {
         required?: string[];
     };
 } | undefined;

use

use: Type<ConfigSource<Opts>>;

watch

watch: boolean | undefined;

refreshOn

refreshOn: "request" | "response" | undefined;

enabled

enabled: boolean;

options

options: Omit<InitialConfigSourceOptions & Opts, "name" | "priority" | "enabled" | "validationSchema" | "watch" | "refreshOn">;