Class TestingModuleBuilder

Builder for creating test modules with provider overrides

Provides a NestJS-style fluent API for configuring test modules. Supports all ModuleOptions properties (imports, providers, controllers, consumers, jobs).

Example: Basic usage

const module = await Test.createTestingModule({
  imports: [RegistrationModule],
}).compile()

Example: Provider override

const module = await Test.createTestingModule({
  imports: [RegistrationModule, GeoModule],
})
  .overrideProvider(EMAIL_TOKENS.EmailService)
  .useValue(mockEmailService)
  .compile()

Example: Full ModuleOptions

const module = await Test.createTestingModule({
  imports: [RegistrationModule],
  providers: [{ provide: MOCK_TOKEN, useValue: mockValue }],
  controllers: [TestController],
  consumers: [TestConsumer],
  jobs: [TestJob],
}).compile()

Index

Constructors

constructor

Methods

addProviderOverride compile overrideProvider withEnv

Constructors

constructor

new TestingModuleBuilder(config: TestingModuleConfig): TestingModuleBuilder
Parameters
- config: TestingModuleConfig
Returns TestingModuleBuilder
- Defined in packages/testing/src/core/testing-module-builder.ts:79

Methods

addProviderOverride

addProviderOverride<T>(override: ProviderOverrideConfig<T>): this
Internal
Add a provider override (internal use by ProviderOverrideBuilder)
Type Parameters
- T
Parameters
- override: ProviderOverrideConfig<T>
Returns this
- Defined in packages/testing/src/core/testing-module-builder.ts:98

compile

compile(): Promise<TestingModule>
Compile the testing module

Creates the Application, applies overrides, initializes, and returns TestingModule. The ModuleRegistry handles all module registrations automatically.

Returns Promise<TestingModule>
Promise - The compiled testing module
- Defined in packages/testing/src/core/testing-module-builder.ts:122

overrideProvider

overrideProvider<T>(token: InjectionToken<T>): ProviderOverrideBuilder<T>
Override a provider with a custom implementation

Returns a ProviderOverrideBuilder for specifying the override type.
Type Parameters
- T
Parameters
- token: InjectionToken<T>
  The injection token to override
Returns ProviderOverrideBuilder<T>
ProviderOverrideBuilder for chaining useValue/useClass/useFactory
- Defined in packages/testing/src/core/testing-module-builder.ts:89

withEnv

withEnv(env: Partial<StratalEnv>): this
Merge additional environment bindings
Parameters
- env: Partial<StratalEnv>
  Partial environment to merge
Returns this
This builder for chaining
- Defined in packages/testing/src/core/testing-module-builder.ts:109

Class TestingModuleBuilder

Example: Basic usage

Example: Provider override

Example: Full ModuleOptions

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TestingModuleBuilder

Methods

addProviderOverride

Type Parameters

Parameters

Returns this

compile

Returns Promise<TestingModule>

overrideProvider

Type Parameters

Parameters

Returns ProviderOverrideBuilder<T>

withEnv

Parameters

Returns this

Settings

On This Page