Skip to content

Class: TestingModuleBuilder

Defined in: packages/testing/src/testing.module-builder.ts:81

Builder for creating and configuring testing modules.

Example

typescript
const moduleRef = await Test.createTestingModule({
  imports: [AppModule],
  providers: [MyService],
})
  .overrideProvider(DatabaseService)
  .useValue(mockDb)
  .compile();

const service = moduleRef.get(MyService);

Constructors

Constructor

ts
new TestingModuleBuilder(metadata): TestingModuleBuilder;

Defined in: packages/testing/src/testing.module-builder.ts:85

Parameters

ParameterType
metadataModuleOptions

Returns

TestingModuleBuilder

Methods

addOverride()

ts
addOverride(override): void;

Defined in: packages/testing/src/testing.module-builder.ts:100

Internal

Add provider override

Parameters

ParameterType
overrideOverridesMetadata

Returns

void


compile()

ts
compile(): Promise<TestingModule>;

Defined in: packages/testing/src/testing.module-builder.ts:125

Compile the testing module and initialize all providers.

Each call creates a fully isolated DI container so that unit tests never interfere with each other or with integration tests that share the global Container.instance.

Returns

Promise<TestingModule>


overrideClass()

ts
overrideClass<T>(token): OverrideByBuilder<T>;

Defined in: packages/testing/src/testing.module-builder.ts:114

Override a class provider

Type Parameters

Type Parameter
T

Parameters

ParameterType
tokenType<T>

Returns

OverrideByBuilder<T>


overrideProvider()

ts
overrideProvider<T>(token): OverrideByBuilder<T>;

Defined in: packages/testing/src/testing.module-builder.ts:107

Override a provider with mock/stub

Type Parameters

Type Parameter
T

Parameters

ParameterType
tokenProviderToken

Returns

OverrideByBuilder<T>

Released under the MIT License.