Interface: ConfigBoundModuleOptions<T>

Defined in: packages/nestjs/src/interfaces/config-bound-module-options.interface.ts:21

Configuration options for ConfigBoundModule. Defines the schema, binds, and behavior for the ConfigBound integration.

Type Parameters

Type Parameter	Default type
T extends ConfigSchema	ConfigSchema

Properties

Property	Type	Description	Defined in
binds?	Bind[]	Value sources consulted in bind order when resolving configuration values.	packages/nestjs/src/interfaces/config-bound-module-options.interface.ts:29
cacheMode?	CacheMode	Cache initialization strategy. Defaults to eager. - eager: Cache is populated during module initialization. Allows synchronous reads via getFromCache() immediate useful in NestJS constructors or other sync-only call sites that cannot await. - manual: Cache is not populated until you explicitly call populateCache(). Use this when you only read config asynchronously via get() or getOrThrow() and want to avoid the upfront startup cost.	packages/nestjs/src/interfaces/config-bound-module-options.interface.ts:40
isGlobal?	boolean	Registers the module globally in Nest when true.	packages/nestjs/src/interfaces/config-bound-module-options.interface.ts:42
logger?	Logger	Optional logger implementation used by ConfigBound internals.	packages/nestjs/src/interfaces/config-bound-module-options.interface.ts:31
name?	string	Optional instance name; defaults to app when omitted.	packages/nestjs/src/interfaces/config-bound-module-options.interface.ts:27
schema	T	Declarative schema that defines sections, elements, defaults, and validators.	packages/nestjs/src/interfaces/config-bound-module-options.interface.ts:25
validateOnInit?	boolean	Validates values during module initialization when true.	packages/nestjs/src/interfaces/config-bound-module-options.interface.ts:33