Interface: DrizzleModuleAsyncOptions

Defined in: packages/drizzle/src/interfaces/drizzle-module.interface.ts:56

Options for asynchronously configuring the Drizzle module.

Properties

Property	Type	Description	Defined in
extraProviders?	Provider[]	Extra providers registered within the scope of this dynamic module.	packages/drizzle/src/interfaces/drizzle-module.interface.ts:111
imports?	unknown[]	Modules whose exported providers should be available as dependencies within this dynamic module's scope.	packages/drizzle/src/interfaces/drizzle-module.interface.ts:75
inject?	( | ProviderToken | { optional?: boolean; token: ProviderToken; })[]	Dependencies injected into the factory function.	packages/drizzle/src/interfaces/drizzle-module.interface.ts:106
isGlobal?	boolean	If true, registers DrizzleModule as a global module. Default false	packages/drizzle/src/interfaces/drizzle-module.interface.ts:69
tag?	string | symbol	Custom injection token for the database instance. Default DRIZZLE_INSTANCE	packages/drizzle/src/interfaces/drizzle-module.interface.ts:62
useClass?	Type<DrizzleOptionsFactory>	Class that implements DrizzleOptionsFactory. An instance will be created and its createDrizzleOptions() method called.	packages/drizzle/src/interfaces/drizzle-module.interface.ts:81
useExisting?	Type<DrizzleOptionsFactory>	Existing provider that implements DrizzleOptionsFactory.	packages/drizzle/src/interfaces/drizzle-module.interface.ts:86
useFactory?	(...args) => | DrizzleModuleOptions | Promise<DrizzleModuleOptions>	Factory function that returns options (or a Promise of options). Example useFactory: (config: ConfigService) => ({ db: drizzle(new Pool({ connectionString: config.get('DATABASE_URL') }), { schema }), }), inject: [ConfigService],	packages/drizzle/src/interfaces/drizzle-module.interface.ts:99