Class ProviderOverrideBuilder<T>

Fluent builder for provider overrides

Provides a NestJS-style API for overriding providers in tests.

Example

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

Type Parameters

Index

Constructors

constructor

Methods

useClass useExisting useFactory useValue

Constructors

constructor

new ProviderOverrideBuilder<T>(
parent: TestingModuleBuilder,
token: InjectionToken<T>,
): ProviderOverrideBuilder<T>
Type Parameters
- T
Parameters
- parent: TestingModuleBuilder
- token: InjectionToken<T>
Returns ProviderOverrideBuilder<T>
- Defined in packages/testing/src/core/override/provider-override-builder.ts:30

Methods

useClass

useClass(cls: new (...args: unknown[]) => T): TestingModuleBuilder
Use a class as the provider

The class will be registered as a singleton.
Parameters
- cls: new (...args: unknown[]) => T
  The class constructor to use as the provider
Returns TestingModuleBuilder
The parent TestingModuleBuilder for chaining
- Defined in packages/testing/src/core/override/provider-override-builder.ts:59

useExisting

useExisting(existingToken: InjectionToken<T>): TestingModuleBuilder
Use an existing token as the provider (alias)

The override token will resolve to the same instance as the target token.
Parameters
- existingToken: InjectionToken<T>
  The token to alias
Returns TestingModuleBuilder
The parent TestingModuleBuilder for chaining
Example
```
const module = await Test.createTestingModule({
  imports: [MyModule],
})
  .overrideProvider(ABSTRACT_TOKEN)
  .useExisting(ConcreteService)
  .compile()
```
- Defined in packages/testing/src/core/override/provider-override-builder.ts:101

useFactory

useFactory(factory: (container: Container) => T): TestingModuleBuilder
Use a factory function as the provider

The factory receives the container and should return the provider instance.
Parameters
- factory: (container: Container) => T
  Factory function that creates the provider
Returns TestingModuleBuilder
The parent TestingModuleBuilder for chaining
- Defined in packages/testing/src/core/override/provider-override-builder.ts:75

useValue

useValue(value: T): TestingModuleBuilder
Use a static value as the provider

The value will be registered directly in the container.
Parameters
- value: T
  The value to use as the provider
Returns TestingModuleBuilder
The parent TestingModuleBuilder for chaining
- Defined in packages/testing/src/core/override/provider-override-builder.ts:43

Class ProviderOverrideBuilder<T>

Example

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ProviderOverrideBuilder<T>

Methods

useClass

Parameters

Returns TestingModuleBuilder

useExisting

Parameters

Returns TestingModuleBuilder

Example

useFactory

Parameters

Returns TestingModuleBuilder

useValue

Parameters

Returns TestingModuleBuilder

Settings

On This Page