TestBed - Angular - W3cubDocs

API

interface TestBed {
  readonly platform: PlatformRef;
  readonly ngModule: Type<any> | Type<any>[];
  initTestEnvironment(ngModule: Type<any> | Type<any>[], platform: PlatformRef, options?: TestEnvironmentOptions | undefined): void;
  resetTestEnvironment(): void;
  resetTestingModule(): TestBed;
  configureCompiler(config: { providers?: any[] | undefined; useJit?: boolean | undefined; }): void;
  configureTestingModule(moduleDef: TestModuleMetadata): TestBed;
  compileComponents(): Promise<any>;
  inject<T>(token: ProviderToken<T>, notFoundValue: undefined, options: InjectOptions & { optional?: false | undefined; }): T;
  inject<T>(token: ProviderToken<T>, notFoundValue: null | undefined, options: InjectOptions): T | null;
  inject<T>(token: ProviderToken<T>, notFoundValue?: T | undefined, options?: InjectOptions | undefined): T;
  runInInjectionContext<T>(fn: () => T): T;
  execute(tokens: any[], fn: Function, context?: any): any;
  overrideModule(ngModule: Type<any>, override: MetadataOverride<NgModule>): TestBed;
  overrideComponent(component: Type<any>, override: MetadataOverride<Component>): TestBed;
  overrideDirective(directive: Type<any>, override: MetadataOverride<Directive>): TestBed;
  overridePipe(pipe: Type<any>, override: MetadataOverride<Pipe>): TestBed;
  overrideTemplate(component: Type<any>, template: string): TestBed;
  overrideProvider(token: any, provider: { useFactory: Function; deps: any[]; multi?: boolean | undefined; }): TestBed;
  overrideProvider(token: any, provider: { useValue: any; multi?: boolean | undefined; }): TestBed;
  overrideProvider(token: any, provider: { useFactory?: Function | undefined; useValue?: any; deps?: any[] | undefined; multi?: boolean | undefined; }): TestBed;
  overrideTemplateUsingTestingModule(component: Type<any>, template: string): TestBed;
  createComponent<T>(component: Type<T>, options?: TestComponentOptions | undefined): ComponentFixture<T>;
  flushEffects(): void;
  tick(): void;
  readonly platform: PlatformRef;
  readonly ngModule: Type<any> | Type<any>[];
  initTestEnvironment(ngModule: Type<any> | Type<any>[], platform: PlatformRef, options?: TestEnvironmentOptions | undefined): void;
  resetTestEnvironment(): void;
  resetTestingModule(): TestBed;
  configureCompiler(config: { providers?: any[] | undefined; useJit?: boolean | undefined; }): void;
  configureTestingModule(moduleDef: TestModuleMetadata): TestBed;
  compileComponents(): Promise<any>;
  inject<T>(token: ProviderToken<T>, notFoundValue: undefined, options: InjectOptions & { optional?: false | undefined; }): T;
  inject<T>(token: ProviderToken<T>, notFoundValue: null | undefined, options: InjectOptions): T | null;
  inject<T>(token: ProviderToken<T>, notFoundValue?: T | undefined, options?: InjectOptions | undefined): T;
  runInInjectionContext<T>(fn: () => T): T;
  execute(tokens: any[], fn: Function, context?: any): any;
  overrideModule(ngModule: Type<any>, override: MetadataOverride<NgModule>): TestBed;
  overrideComponent(component: Type<any>, override: MetadataOverride<Component>): TestBed;
  overrideDirective(directive: Type<any>, override: MetadataOverride<Directive>): TestBed;
  overridePipe(pipe: Type<any>, override: MetadataOverride<Pipe>): TestBed;
  overrideTemplate(component: Type<any>, template: string): TestBed;
  overrideProvider(token: any, provider: { useFactory: Function; deps: any[]; multi?: boolean | undefined; }): TestBed;
  overrideProvider(token: any, provider: { useValue: any; multi?: boolean | undefined; }): TestBed;
  overrideProvider(token: any, provider: { useFactory?: Function | undefined; useValue?: any; deps?: any[] | undefined; multi?: boolean | undefined; }): TestBed;
  overrideTemplateUsingTestingModule(component: Type<any>, template: string): TestBed;
  createComponent<T>(component: Type<T>, options?: TestComponentOptions | undefined): ComponentFixture<T>;
  flushEffects(): void;
  tick(): void;
}

platform

PlatformRef

ngModule

Type<any> | Type<any>[]

initTestEnvironment

void

Initialize the environment for testing with a compiler factory, a PlatformRef, and an angular module. These are common to every test in the suite.

This may only be called once, to set up the common providers for the current test suite on the current platform. If you absolutely need to change the providers, first use resetTestEnvironment.

Test modules and platforms for individual platforms are available from '@angular//testing'.

@paramngModuleType<any> | Type<any>[]

@paramplatformPlatformRef

@paramoptionsTestEnvironmentOptions | undefined

@returnsvoid

resetTestEnvironment

void

Reset the providers for the test injector.

@returnsvoid

resetTestingModule

TestBed

@returnsTestBed

configureCompiler

void

@paramconfig{ providers?: any[] | undefined; useJit?: boolean | undefined; }

@returnsvoid

configureTestingModule

TestBed

@parammoduleDefTestModuleMetadata

@returnsTestBed

compileComponents

Promise<any>

@returnsPromise<any>

inject

T

@paramtokenProviderToken<T>

@paramnotFoundValueundefined

@paramoptionsInjectOptions & { optional?: false | undefined; }

@returnsT

inject

T | null

@paramtokenProviderToken<T>

@paramnotFoundValuenull | undefined

@paramoptionsInjectOptions

@returnsT | null

inject

T

@paramtokenProviderToken<T>

@paramnotFoundValueT | undefined

@paramoptionsInjectOptions | undefined

@returnsT

runInInjectionContext

T

Runs the given function in the EnvironmentInjector context of TestBed.

@paramfn() => T

@returnsT

execute

any

@paramtokensany[]

@paramfnFunction

@paramcontextany

@returnsany

overrideModule

TestBed

@paramngModuleType<any>

@paramoverrideMetadataOverride<NgModule>

@returnsTestBed

overrideComponent

TestBed

@paramcomponentType<any>

@paramoverrideMetadataOverride<Component>

@returnsTestBed

overrideDirective

TestBed

@paramdirectiveType<any>

@paramoverrideMetadataOverride<Directive>

@returnsTestBed

overridePipe

TestBed

@parampipeType<any>

@paramoverrideMetadataOverride<Pipe>

@returnsTestBed

overrideTemplate

TestBed

@paramcomponentType<any>

@paramtemplatestring

@returnsTestBed

overrideProvider

TestBed

Overwrites all providers for the given token with the given provider definition.

@paramtokenany

@paramprovider{ useFactory: Function; deps: any[]; multi?: boolean | undefined; }

@returnsTestBed

overrideProvider

TestBed

@paramtokenany

@paramprovider{ useValue: any; multi?: boolean | undefined; }

@returnsTestBed

overrideProvider

TestBed

@paramtokenany

@paramprovider{ useFactory?: Function | undefined; useValue?: any; deps?: any[] | undefined; multi?: boolean | undefined; }

@returnsTestBed

overrideTemplateUsingTestingModule

TestBed

@paramcomponentType<any>

@paramtemplatestring

@returnsTestBed

createComponent

ComponentFixture<T>

@paramcomponentType<T>

@paramoptionsTestComponentOptions | undefined

@returnsComponentFixture<T>

flushEffects

void

Execute any pending effects.

@deprecated

use TestBed.tick() instead

@returnsvoid

tick

void

Execute any pending work required to synchronize model to the UI.

@returnsvoid

platform

PlatformRef

ngModule

Type<any> | Type<any>[]

initTestEnvironment

void

Initialize the environment for testing with a compiler factory, a PlatformRef, and an angular module. These are common to every test in the suite.

This may only be called once, to set up the common providers for the current test suite on the current platform. If you absolutely need to change the providers, first use resetTestEnvironment.

Test modules and platforms for individual platforms are available from '@angular//testing'.

@paramngModuleType<any> | Type<any>[]

@paramplatformPlatformRef

@paramoptionsTestEnvironmentOptions | undefined

@returnsvoid

resetTestEnvironment

void

Reset the providers for the test injector.

@returnsvoid

resetTestingModule

TestBed

@returnsTestBed

configureCompiler

void

@paramconfig{ providers?: any[] | undefined; useJit?: boolean | undefined; }

@returnsvoid

configureTestingModule

TestBed

@parammoduleDefTestModuleMetadata

@returnsTestBed

compileComponents

Promise<any>

@returnsPromise<any>

inject

T

@paramtokenProviderToken<T>

@paramnotFoundValueundefined

@paramoptionsInjectOptions & { optional?: false | undefined; }

@returnsT

inject

T | null

@paramtokenProviderToken<T>

@paramnotFoundValuenull | undefined

@paramoptionsInjectOptions

@returnsT | null

inject

T

@paramtokenProviderToken<T>

@paramnotFoundValueT | undefined

@paramoptionsInjectOptions | undefined

@returnsT

runInInjectionContext

T

Runs the given function in the EnvironmentInjector context of TestBed.

@paramfn() => T

@returnsT

execute

any

@paramtokensany[]

@paramfnFunction

@paramcontextany

@returnsany

overrideModule

TestBed

@paramngModuleType<any>

@paramoverrideMetadataOverride<NgModule>

@returnsTestBed

overrideComponent

TestBed

@paramcomponentType<any>

@paramoverrideMetadataOverride<Component>

@returnsTestBed

overrideDirective

TestBed

@paramdirectiveType<any>

@paramoverrideMetadataOverride<Directive>

@returnsTestBed

overridePipe

TestBed

@parampipeType<any>

@paramoverrideMetadataOverride<Pipe>

@returnsTestBed

overrideTemplate

TestBed

@paramcomponentType<any>

@paramtemplatestring

@returnsTestBed

overrideProvider

TestBed

Overwrites all providers for the given token with the given provider definition.

@paramtokenany

@paramprovider{ useFactory: Function; deps: any[]; multi?: boolean | undefined; }

@returnsTestBed

overrideProvider

TestBed

@paramtokenany

@paramprovider{ useValue: any; multi?: boolean | undefined; }

@returnsTestBed

overrideProvider

TestBed

@paramtokenany

@paramprovider{ useFactory?: Function | undefined; useValue?: any; deps?: any[] | undefined; multi?: boolean | undefined; }

@returnsTestBed

overrideTemplateUsingTestingModule

TestBed

@paramcomponentType<any>

@paramtemplatestring

@returnsTestBed

createComponent

ComponentFixture<T>

@paramcomponentType<T>

@paramoptionsTestComponentOptions | undefined

@returnsComponentFixture<T>

flushEffects

void

Execute any pending effects.

@deprecated

use TestBed.tick() instead

@returnsvoid

tick

void

Execute any pending work required to synchronize model to the UI.

@returnsvoid