Skip to main content

Function: setupYamlBaseConfigModule

config/src.setupYamlBaseConfigModule

setupYamlBaseConfigModule(baseDir, rootSchemaClass, options?): object

Parameters​

▪ baseDir: string

▪ rootSchemaClass: Type<unknown>

▪ options?: SetupConfigOptions

Returns​

object

controllers​

controllers?: Type<any>[]

Optional list of controllers defined in this module which have to be instantiated.

exports​

exports: (string | symbol | Function | DynamicModule | ClassProvider<any> | ValueProvider<any> | FactoryProvider<any> | ExistingProvider<any> | Promise<DynamicModule> | ForwardReference<any>)[]

global​

global?: boolean

When "true", makes a module global-scoped.

Once imported into any module, a global-scoped module will be visible in all modules. Thereafter, modules that wish to inject a service exported from a global module do not need to import the provider module.

Default​

false

imports​

imports?: (DynamicModule | Type<any> | Promise<DynamicModule> | ForwardReference<any>)[]

Optional list of imported modules that export the providers which are required in this module.

module​

module: Type<any>

A module reference

providers​

providers: Provider[]

Source​

libs/config/src/lib/yaml-config-module.ts:7

Generated using typedoc-plugin-markdown and TypeDoc