package.testing.index.d.ts Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Show all versions of core Show documentation
Angular - the core framework
/**
* @license Angular v18.2.6
* (c) 2010-2024 Google LLC. https://angular.io/
* License: MIT
*/
import { ChangeDetectorRef } from '@angular/core';
import { Component } from '@angular/core';
import { ComponentRef } from '@angular/core';
import { DebugElement } from '@angular/core';
import { ɵDeferBlockBehavior as DeferBlockBehavior } from '@angular/core';
import { ɵDeferBlockState as DeferBlockState } from '@angular/core';
import { Directive } from '@angular/core';
import { ElementRef } from '@angular/core';
import { InjectFlags } from '@angular/core';
import { InjectionToken } from '@angular/core';
import { InjectOptions } from '@angular/core';
import { NgModule } from '@angular/core';
import { NgZone } from '@angular/core';
import { Pipe } from '@angular/core';
import { PlatformRef } from '@angular/core';
import { ProviderToken } from '@angular/core';
import { SchemaMetadata } from '@angular/core';
import { Type } from '@angular/core';
import { ɵDeferBlockDetails } from '@angular/core';
/**
* This API should be removed. But doing so seems to break `google3` and so it requires a bit of
* investigation.
*
* A work around is to mark it as `@codeGenApi` for now and investigate later.
*
* @codeGenApi
*/
export declare const __core_private_testing_placeholder__ = "";
/**
* Fixture for debugging and testing a component.
*
* @publicApi
*/
export declare abstract class ComponentFixture {
componentRef: ComponentRef;
/**
* The DebugElement associated with the root element of this component.
*/
debugElement: DebugElement;
/**
* The instance of the root component class.
*/
componentInstance: T;
/**
* The native element at the root of the component.
*/
nativeElement: any;
/**
* The ElementRef for the element at the root of the component.
*/
elementRef: ElementRef;
/**
* The ChangeDetectorRef for the component
*/
changeDetectorRef: ChangeDetectorRef;
private _renderer;
private _isDestroyed;
private readonly pendingTasks;
private readonly appErrorHandler;
ngZone: NgZone | null;
/** @nodoc */
constructor(componentRef: ComponentRef);
/**
* Trigger a change detection cycle for the component.
*/
abstract detectChanges(checkNoChanges?: boolean): void;
/**
* Do a change detection run to make sure there were no changes.
*/
checkNoChanges(): void;
/**
* Set whether the fixture should autodetect changes.
*
* Also runs detectChanges once so that any existing change is detected.
*/
abstract autoDetectChanges(autoDetect?: boolean): void;
/**
* Return whether the fixture is currently stable or has async tasks that have not been completed
* yet.
*/
isStable(): boolean;
/**
* Get a promise that resolves when the fixture is stable.
*
* This can be used to resume testing after events have triggered asynchronous activity or
* asynchronous change detection.
*/
whenStable(): Promise;
/**
* Retrieves all defer block fixtures in the component fixture.
*/
getDeferBlocks(): Promise;
private _getRenderer;
/**
* Get a promise that resolves when the ui state is stable following animations.
*/
whenRenderingDone(): Promise;
/**
* Trigger component destruction.
*/
destroy(): void;
}
/**
* @publicApi
*/
export declare const ComponentFixtureAutoDetect: InjectionToken;
/**
* @publicApi
*/
export declare const ComponentFixtureNoNgZone: InjectionToken;
export { DeferBlockBehavior }
/**
* Represents an individual defer block for testing purposes.
*
* @publicApi
*/
export declare class DeferBlockFixture {
private block;
private componentFixture;
/** @nodoc */
constructor(block: ɵDeferBlockDetails, componentFixture: ComponentFixture);
/**
* Renders the specified state of the defer fixture.
* @param state the defer state to render
*/
render(state: DeferBlockState): Promise;
/**
* Retrieves all nested child defer block fixtures
* in a given defer block.
*/
getDeferBlocks(): Promise;
}
export { DeferBlockState }
/**
* Discard all remaining periodic tasks.
*
* @publicApi
*/
export declare function discardPeriodicTasks(): void;
/**
* Wraps a function to be executed in the `fakeAsync` zone:
* - Microtasks are manually executed by calling `flushMicrotasks()`.
* - Timers are synchronous; `tick()` simulates the asynchronous passage of time.
*
* Can be used to wrap `inject()` calls.
*
* @param fn The function that you want to wrap in the `fakeAsync` zone.
* @param options
* - flush: When true, will drain the macrotask queue after the test function completes.
* When false, will throw an exception at the end of the function if there are pending timers.
*
* @usageNotes
* ### Example
*
* {@example core/testing/ts/fake_async.ts region='basic'}
*
*
* @returns The function wrapped to be executed in the `fakeAsync` zone.
* Any arguments passed when calling this returned function will be passed through to the `fn`
* function in the parameters when it is called.
*
* @publicApi
*/
export declare function fakeAsync(fn: Function, options?: {
flush?: boolean;
}): (...args: any[]) => any;
/**
* Flushes any pending microtasks and simulates the asynchronous passage of time for the timers in
* the `fakeAsync` zone by
* draining the macrotask queue until it is empty.
*
* @param maxTurns The maximum number of times the scheduler attempts to clear its queue before
* throwing an error.
* @returns The simulated time elapsed, in milliseconds.
*
* @publicApi
*/
export declare function flush(maxTurns?: number): number;
/**
* Flush any pending microtasks.
*
* @publicApi
*/
export declare function flushMicrotasks(): void;
/**
* Returns a singleton of the `TestBed` class.
*
* @publicApi
*/
export declare function getTestBed(): TestBed;
/**
* Allows injecting dependencies in `beforeEach()` and `it()`. Note: this function
* (imported from the `@angular/core/testing` package) can **only** be used to inject dependencies
* in tests. To inject dependencies in your application code, use the [`inject`](api/core/inject)
* function from the `@angular/core` package instead.
*
* Example:
*
* ```
* beforeEach(inject([Dependency, AClass], (dep, object) => {
* // some code that uses `dep` and `object`
* // ...
* }));
*
* it('...', inject([AClass], (object) => {
* object.doSomething();
* expect(...);
* })
* ```
*
* @publicApi
*/
export declare function inject(tokens: any[], fn: Function): () => any;
/**
* @publicApi
*/
export declare class InjectSetupWrapper {
private _moduleDef;
constructor(_moduleDef: () => TestModuleMetadata);
private _addModule;
inject(tokens: any[], fn: Function): () => any;
}
/**
* Type used for modifications to metadata
*
* @publicApi
*/
export declare type MetadataOverride = {
add?: Partial;
remove?: Partial;
set?: Partial;
};
/**
* Configures the test module teardown behavior in `TestBed`.
* @publicApi
*/
export declare interface ModuleTeardownOptions {
/** Whether the test module should be destroyed after every test. Defaults to `true`. */
destroyAfterEach: boolean;
/** Whether errors during test module destruction should be re-thrown. Defaults to `true`. */
rethrowErrors?: boolean;
}
/**
* Clears out the shared fake async zone for a test.
* To be called in a global `beforeEach`.
*
* @publicApi
*/
export declare function resetFakeAsyncZone(): void;
/**
* @publicApi
*/
export declare interface TestBed {
get platform(): PlatformRef;
get ngModule(): Type | Type[];
/**
* 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'.
*/
initTestEnvironment(ngModule: Type | Type[], platform: PlatformRef, options?: TestEnvironmentOptions): void;
/**
* Reset the providers for the test injector.
*/
resetTestEnvironment(): void;
resetTestingModule(): TestBed;
configureCompiler(config: {
providers?: any[];
useJit?: boolean;
}): void;
configureTestingModule(moduleDef: TestModuleMetadata): TestBed;
compileComponents(): Promise;
inject(token: ProviderToken, notFoundValue: undefined, options: InjectOptions & {
optional?: false;
}): T;
inject(token: ProviderToken, notFoundValue: null | undefined, options: InjectOptions): T | null;
inject(token: ProviderToken, notFoundValue?: T, options?: InjectOptions): T;
/** @deprecated use object-based flags (`InjectOptions`) instead. */
inject(token: ProviderToken, notFoundValue?: T, flags?: InjectFlags): T;
/** @deprecated use object-based flags (`InjectOptions`) instead. */
inject(token: ProviderToken, notFoundValue: null, flags?: InjectFlags): T | null;
/** @deprecated from v9.0.0 use TestBed.inject */
get(token: ProviderToken, notFoundValue?: T, flags?: InjectFlags): any;
/** @deprecated from v9.0.0 use TestBed.inject */
get(token: any, notFoundValue?: any): any;
/**
* Runs the given function in the `EnvironmentInjector` context of `TestBed`.
*
* @see {@link EnvironmentInjector#runInContext}
*/
runInInjectionContext(fn: () => T): T;
execute(tokens: any[], fn: Function, context?: any): any;
overrideModule(ngModule: Type, override: MetadataOverride): TestBed;
overrideComponent(component: Type, override: MetadataOverride): TestBed;
overrideDirective(directive: Type, override: MetadataOverride): TestBed;
overridePipe(pipe: Type, override: MetadataOverride): TestBed;
overrideTemplate(component: Type, template: string): TestBed;
/**
* Overwrites all providers for the given token with the given provider definition.
*/
overrideProvider(token: any, provider: {
useFactory: Function;
deps: any[];
multi?: boolean;
}): TestBed;
overrideProvider(token: any, provider: {
useValue: any;
multi?: boolean;
}): TestBed;
overrideProvider(token: any, provider: {
useFactory?: Function;
useValue?: any;
deps?: any[];
multi?: boolean;
}): TestBed;
overrideTemplateUsingTestingModule(component: Type, template: string): TestBed;
createComponent(component: Type): ComponentFixture;
/**
* Execute any pending effects.
*
* @developerPreview
*/
flushEffects(): void;
}
/**
* @description
* Configures and initializes environment for unit testing and provides methods for
* creating components and services in unit tests.
*
* `TestBed` is the primary api for writing unit tests for Angular applications and libraries.
*
* @publicApi
*/
export declare const TestBed: TestBedStatic;
/**
* Static methods implemented by the `TestBed`.
*
* @publicApi
*/
export declare interface TestBedStatic extends TestBed {
new (...args: any[]): TestBed;
}
/**
* An abstract class for inserting the root test component element in a platform independent way.
*
* @publicApi
*/
export declare class TestComponentRenderer {
insertRootElement(rootElementId: string): void;
removeAllRootElements?(): void;
}
/**
* @publicApi
*/
export declare interface TestEnvironmentOptions {
/**
* Configures the test module teardown behavior in `TestBed`.
*/
teardown?: ModuleTeardownOptions;
/**
* Whether errors should be thrown when unknown elements are present in component's template.
* Defaults to `false`, where the error is simply logged.
* If set to `true`, the error is thrown.
* @see [NG8001](/errors/NG8001) for the description of the error and how to fix it
*/
errorOnUnknownElements?: boolean;
/**
* Whether errors should be thrown when unknown properties are present in component's template.
* Defaults to `false`, where the error is simply logged.
* If set to `true`, the error is thrown.
* @see [NG8002](/errors/NG8002) for the description of the error and how to fix it
*/
errorOnUnknownProperties?: boolean;
}
/**
* @publicApi
*/
export declare interface TestModuleMetadata {
providers?: any[];
declarations?: any[];
imports?: any[];
schemas?: Array;
teardown?: ModuleTeardownOptions;
/**
* Whether NG0304 runtime errors should be thrown when unknown elements are present in component's
* template. Defaults to `false`, where the error is simply logged. If set to `true`, the error is
* thrown.
* @see [NG8001](/errors/NG8001) for the description of the problem and how to fix it
*/
errorOnUnknownElements?: boolean;
/**
* Whether errors should be thrown when unknown properties are present in component's template.
* Defaults to `false`, where the error is simply logged.
* If set to `true`, the error is thrown.
* @see [NG8002](/errors/NG8002) for the description of the error and how to fix it
*/
errorOnUnknownProperties?: boolean;
/**
* Whether defer blocks should behave with manual triggering or play through normally.
* Defaults to `manual`.
*/
deferBlockBehavior?: DeferBlockBehavior;
}
/**
* Simulates the asynchronous passage of time for the timers in the `fakeAsync` zone.
*
* The microtasks queue is drained at the very start of this function and after any timer callback
* has been executed.
*
* @param millis The number of milliseconds to advance the virtual timer.
* @param tickOptions The options to pass to the `tick()` function.
*
* @usageNotes
*
* The `tick()` option is a flag called `processNewMacroTasksSynchronously`,
* which determines whether or not to invoke new macroTasks.
*
* If you provide a `tickOptions` object, but do not specify a
* `processNewMacroTasksSynchronously` property (`tick(100, {})`),
* then `processNewMacroTasksSynchronously` defaults to true.
*
* If you omit the `tickOptions` parameter (`tick(100))`), then
* `tickOptions` defaults to `{processNewMacroTasksSynchronously: true}`.
*
* ### Example
*
* {@example core/testing/ts/fake_async.ts region='basic'}
*
* The following example includes a nested timeout (new macroTask), and
* the `tickOptions` parameter is allowed to default. In this case,
* `processNewMacroTasksSynchronously` defaults to true, and the nested
* function is executed on each tick.
*
* ```
* it ('test with nested setTimeout', fakeAsync(() => {
* let nestedTimeoutInvoked = false;
* function funcWithNestedTimeout() {
* setTimeout(() => {
* nestedTimeoutInvoked = true;
* });
* };
* setTimeout(funcWithNestedTimeout);
* tick();
* expect(nestedTimeoutInvoked).toBe(true);
* }));
* ```
*
* In the following case, `processNewMacroTasksSynchronously` is explicitly
* set to false, so the nested timeout function is not invoked.
*
* ```
* it ('test with nested setTimeout', fakeAsync(() => {
* let nestedTimeoutInvoked = false;
* function funcWithNestedTimeout() {
* setTimeout(() => {
* nestedTimeoutInvoked = true;
* });
* };
* setTimeout(funcWithNestedTimeout);
* tick(0, {processNewMacroTasksSynchronously: false});
* expect(nestedTimeoutInvoked).toBe(false);
* }));
* ```
*
*
* @publicApi
*/
export declare function tick(millis?: number, tickOptions?: {
processNewMacroTasksSynchronously: boolean;
}): void;
/**
* Wraps a test function in an asynchronous test zone. The test will automatically
* complete when all asynchronous calls within this zone are done. Can be used
* to wrap an {@link inject} call.
*
* Example:
*
* ```
* it('...', waitForAsync(inject([AClass], (object) => {
* object.doSomething.then(() => {
* expect(...);
* })
* })));
* ```
*
* @publicApi
*/
export declare function waitForAsync(fn: Function): (done: any) => any;
/**
* @publicApi
*/
export declare function withModule(moduleDef: TestModuleMetadata): InjectSetupWrapper;
export declare function withModule(moduleDef: TestModuleMetadata, fn: Function): () => any;
export declare class ɵMetadataOverrider {
private _references;
/**
* Creates a new instance for the given metadata class
* based on an old instance and overrides.
*/
overrideMetadata(metadataClass: {
new (options: T): C;
}, oldMetadata: C, override: MetadataOverride): C;
}
export { }