2016-07-29 07:19:02 -04:00
|
|
|
/** @deprecated */
|
refactor(testing): remove wrapping of Jasmine functions (#9564)
Instead, the async function now determines whether it should return a promise
or instead call a done function parameter. Importing Jasmine functions
from `@angular/core/testing` is no longer necessary and is now deprecated.
Additionally, beforeEachProviders is also deprecated, as it is specific
to the testing framework. Instead, use the new addProviders method directly.
Before:
```js
import {beforeEachProviders, it, describe, inject} from 'angular2/testing/core';
describe('my code', () => {
beforeEachProviders(() => [MyService]);
it('does stuff', inject([MyService], (service) => {
// actual test
});
});
```
After:
```js
import {addProviders, inject} from 'angular2/testing/core';
describe('my code', () => {
beforeEach(() => {
addProviders([MyService]);
});
it('does stuff', inject([MyService], (service) => {
// actual test
});
});
```
2016-06-24 20:48:35 -04:00
|
|
|
export declare function addProviders(providers: Array<any>): void;
|
|
|
|
|
|
2016-06-27 15:27:23 -04:00
|
|
|
/** @stable */
|
refactor(testing): remove wrapping of Jasmine functions (#9564)
Instead, the async function now determines whether it should return a promise
or instead call a done function parameter. Importing Jasmine functions
from `@angular/core/testing` is no longer necessary and is now deprecated.
Additionally, beforeEachProviders is also deprecated, as it is specific
to the testing framework. Instead, use the new addProviders method directly.
Before:
```js
import {beforeEachProviders, it, describe, inject} from 'angular2/testing/core';
describe('my code', () => {
beforeEachProviders(() => [MyService]);
it('does stuff', inject([MyService], (service) => {
// actual test
});
});
```
After:
```js
import {addProviders, inject} from 'angular2/testing/core';
describe('my code', () => {
beforeEach(() => {
addProviders([MyService]);
});
it('does stuff', inject([MyService], (service) => {
// actual test
});
});
```
2016-06-24 20:48:35 -04:00
|
|
|
export declare function async(fn: Function): (done: any) => any;
|
2016-06-22 17:56:10 -04:00
|
|
|
|
2016-06-27 15:27:23 -04:00
|
|
|
/** @stable */
|
2016-06-24 15:41:49 -04:00
|
|
|
export declare class ComponentFixture<T> {
|
|
|
|
|
changeDetectorRef: ChangeDetectorRef;
|
feat(browser): use AppModules for bootstrap in the browser
This introduces the `BrowserModule` to be used for long form
bootstrap and offline compile bootstrap:
```
@AppModule({
modules: [BrowserModule],
precompile: [MainComponent],
providers: […], // additional providers
directives: […], // additional platform directives
pipes: […] // additional platform pipes
})
class MyModule {
constructor(appRef: ApplicationRef) {
appRef.bootstrap(MainComponent);
}
}
// offline compile
import {bootstrapModuleFactory} from ‘@angular/platform-browser’;
bootstrapModuleFactory(MyModuleNgFactory);
// runtime compile long form
import {bootstrapModule} from ‘@angular/platform-browser-dynamic’;
bootstrapModule(MyModule);
```
The short form, `bootstrap(...)`, can now creates a module on the fly,
given `directives`, `pipes, `providers`, `precompile` and `modules`
properties.
Related changes:
- make `SanitizationService`, `SecurityContext` public in `@angular/core` so that the offline compiler can resolve the token
- move `AnimationDriver` to `platform-browser` and make it
public so that the offline compiler can resolve the token
BREAKING CHANGES:
- short form bootstrap does no longer allow
to inject compiler internals (i.e. everything
from `@angular/compiler). Inject `Compiler` instead.
To provide custom providers for the compiler,
create a custom compiler via `browserCompiler({providers: [...]})`
and pass that into the `bootstrap` method.
2016-06-30 16:07:17 -04:00
|
|
|
componentInstance: T;
|
2016-06-24 15:41:49 -04:00
|
|
|
componentRef: ComponentRef<T>;
|
|
|
|
|
debugElement: DebugElement;
|
|
|
|
|
elementRef: ElementRef;
|
|
|
|
|
nativeElement: any;
|
|
|
|
|
ngZone: NgZone;
|
|
|
|
|
constructor(componentRef: ComponentRef<T>, ngZone: NgZone, autoDetect: boolean);
|
|
|
|
|
autoDetectChanges(autoDetect?: boolean): void;
|
|
|
|
|
checkNoChanges(): void;
|
|
|
|
|
destroy(): void;
|
|
|
|
|
detectChanges(checkNoChanges?: boolean): void;
|
|
|
|
|
isStable(): boolean;
|
|
|
|
|
whenStable(): Promise<any>;
|
|
|
|
|
}
|
|
|
|
|
|
2016-06-27 15:27:23 -04:00
|
|
|
/** @experimental */
|
2016-06-24 20:35:01 -04:00
|
|
|
export declare var ComponentFixtureAutoDetect: OpaqueToken;
|
|
|
|
|
|
2016-06-27 15:27:23 -04:00
|
|
|
/** @experimental */
|
2016-06-24 20:35:01 -04:00
|
|
|
export declare var ComponentFixtureNoNgZone: OpaqueToken;
|
|
|
|
|
|
2016-06-27 15:27:23 -04:00
|
|
|
/** @experimental */
|
2016-06-22 17:56:10 -04:00
|
|
|
export declare function discardPeriodicTasks(): void;
|
|
|
|
|
|
2016-06-27 15:27:23 -04:00
|
|
|
/** @experimental */
|
refactor(testing): remove wrapping of Jasmine functions (#9564)
Instead, the async function now determines whether it should return a promise
or instead call a done function parameter. Importing Jasmine functions
from `@angular/core/testing` is no longer necessary and is now deprecated.
Additionally, beforeEachProviders is also deprecated, as it is specific
to the testing framework. Instead, use the new addProviders method directly.
Before:
```js
import {beforeEachProviders, it, describe, inject} from 'angular2/testing/core';
describe('my code', () => {
beforeEachProviders(() => [MyService]);
it('does stuff', inject([MyService], (service) => {
// actual test
});
});
```
After:
```js
import {addProviders, inject} from 'angular2/testing/core';
describe('my code', () => {
beforeEach(() => {
addProviders([MyService]);
});
it('does stuff', inject([MyService], (service) => {
// actual test
});
});
```
2016-06-24 20:48:35 -04:00
|
|
|
export declare function fakeAsync(fn: Function): (...args: any[]) => any;
|
2016-06-22 17:56:10 -04:00
|
|
|
|
2016-06-27 15:27:23 -04:00
|
|
|
/** @experimental */
|
2016-06-22 17:56:10 -04:00
|
|
|
export declare function flushMicrotasks(): void;
|
|
|
|
|
|
2016-06-27 15:27:23 -04:00
|
|
|
/** @experimental */
|
2016-07-20 13:51:21 -04:00
|
|
|
export declare function getTestBed(): TestBed;
|
|
|
|
|
|
|
|
|
|
/** @deprecated */
|
|
|
|
|
export declare function getTestInjector(): TestBed;
|
2016-06-22 17:56:10 -04:00
|
|
|
|
2016-06-27 15:27:23 -04:00
|
|
|
/** @stable */
|
refactor(testing): remove wrapping of Jasmine functions (#9564)
Instead, the async function now determines whether it should return a promise
or instead call a done function parameter. Importing Jasmine functions
from `@angular/core/testing` is no longer necessary and is now deprecated.
Additionally, beforeEachProviders is also deprecated, as it is specific
to the testing framework. Instead, use the new addProviders method directly.
Before:
```js
import {beforeEachProviders, it, describe, inject} from 'angular2/testing/core';
describe('my code', () => {
beforeEachProviders(() => [MyService]);
it('does stuff', inject([MyService], (service) => {
// actual test
});
});
```
After:
```js
import {addProviders, inject} from 'angular2/testing/core';
describe('my code', () => {
beforeEach(() => {
addProviders([MyService]);
});
it('does stuff', inject([MyService], (service) => {
// actual test
});
});
```
2016-06-24 20:48:35 -04:00
|
|
|
export declare function inject(tokens: any[], fn: Function): () => any;
|
2016-06-22 17:56:10 -04:00
|
|
|
|
2016-06-27 15:27:23 -04:00
|
|
|
/** @experimental */
|
2016-06-22 17:56:10 -04:00
|
|
|
export declare class InjectSetupWrapper {
|
2016-07-29 07:19:02 -04:00
|
|
|
constructor(_moduleDef: () => TestModuleMetadata);
|
refactor(testing): remove wrapping of Jasmine functions (#9564)
Instead, the async function now determines whether it should return a promise
or instead call a done function parameter. Importing Jasmine functions
from `@angular/core/testing` is no longer necessary and is now deprecated.
Additionally, beforeEachProviders is also deprecated, as it is specific
to the testing framework. Instead, use the new addProviders method directly.
Before:
```js
import {beforeEachProviders, it, describe, inject} from 'angular2/testing/core';
describe('my code', () => {
beforeEachProviders(() => [MyService]);
it('does stuff', inject([MyService], (service) => {
// actual test
});
});
```
After:
```js
import {addProviders, inject} from 'angular2/testing/core';
describe('my code', () => {
beforeEach(() => {
addProviders([MyService]);
});
it('does stuff', inject([MyService], (service) => {
// actual test
});
});
```
2016-06-24 20:48:35 -04:00
|
|
|
inject(tokens: any[], fn: Function): () => any;
|
2016-06-22 17:56:10 -04:00
|
|
|
}
|
|
|
|
|
|
2016-07-29 07:19:02 -04:00
|
|
|
/** @experimental */
|
|
|
|
|
export declare type MetadataOverride<T> = {
|
|
|
|
|
add?: T;
|
|
|
|
|
remove?: T;
|
|
|
|
|
set?: T;
|
|
|
|
|
};
|
|
|
|
|
|
2016-07-11 17:01:11 -04:00
|
|
|
/** @deprecated */
|
|
|
|
|
export declare function resetBaseTestProviders(): void;
|
|
|
|
|
|
|
|
|
|
/** @deprecated */
|
|
|
|
|
export declare function setBaseTestProviders(platformProviders: Array<Type | Provider | any[]>, applicationProviders: Array<Type | Provider | any[]>): void;
|
|
|
|
|
|
2016-07-20 13:51:21 -04:00
|
|
|
/** @experimental */
|
|
|
|
|
export declare class TestBed implements Injector {
|
2016-07-18 06:50:31 -04:00
|
|
|
ngModule: Type;
|
2016-07-20 13:51:21 -04:00
|
|
|
platform: PlatformRef;
|
2016-07-29 07:19:02 -04:00
|
|
|
compileComponents(): Promise<any>;
|
2016-07-20 13:51:21 -04:00
|
|
|
configureCompiler(config: {
|
|
|
|
|
providers?: any[];
|
|
|
|
|
useJit?: boolean;
|
|
|
|
|
}): void;
|
2016-07-29 07:19:02 -04:00
|
|
|
configureTestingModule(moduleDef: TestModuleMetadata): void;
|
|
|
|
|
createComponent<T>(component: ConcreteType<T>): ComponentFixture<T>;
|
2016-07-20 13:51:21 -04:00
|
|
|
execute(tokens: any[], fn: Function): any;
|
|
|
|
|
get(token: any, notFoundValue?: any): any;
|
2016-07-29 07:19:02 -04:00
|
|
|
/** @experimental */ initTestEnvironment(ngModule: Type, platform: PlatformRef): void;
|
|
|
|
|
overrideComponent(component: ConcreteType<any>, override: MetadataOverride<ComponentMetadataType>): void;
|
|
|
|
|
overrideDirective(directive: ConcreteType<any>, override: MetadataOverride<DirectiveMetadataType>): void;
|
|
|
|
|
overrideModule(ngModule: ConcreteType<any>, override: MetadataOverride<NgModuleMetadataType>): void;
|
|
|
|
|
overridePipe(pipe: ConcreteType<any>, override: MetadataOverride<PipeMetadataType>): void;
|
|
|
|
|
/** @deprecated */ reset(): void;
|
|
|
|
|
/** @experimental */ resetTestEnvironment(): void;
|
|
|
|
|
resetTestingModule(): void;
|
|
|
|
|
static compileComponents(): Promise<any>;
|
|
|
|
|
static configureCompiler(config: {
|
|
|
|
|
providers?: any[];
|
|
|
|
|
useJit?: boolean;
|
|
|
|
|
}): typeof TestBed;
|
|
|
|
|
static configureTestingModule(moduleDef: TestModuleMetadata): typeof TestBed;
|
|
|
|
|
static createComponent<T>(component: ConcreteType<T>): ComponentFixture<T>;
|
|
|
|
|
/** @experimental */ static initTestEnvironment(ngModule: Type, platform: PlatformRef): TestBed;
|
|
|
|
|
static overrideComponent(component: ConcreteType<any>, override: MetadataOverride<ComponentMetadataType>): typeof TestBed;
|
|
|
|
|
static overrideDirective(directive: ConcreteType<any>, override: MetadataOverride<DirectiveMetadataType>): typeof TestBed;
|
|
|
|
|
static overrideModule(ngModule: ConcreteType<any>, override: MetadataOverride<NgModuleMetadataType>): typeof TestBed;
|
|
|
|
|
static overridePipe(pipe: ConcreteType<any>, override: MetadataOverride<PipeMetadataType>): typeof TestBed;
|
|
|
|
|
/** @experimental */ static resetTestEnvironment(): void;
|
|
|
|
|
static resetTestingModule(): typeof TestBed;
|
2016-07-20 13:51:21 -04:00
|
|
|
}
|
|
|
|
|
|
2016-07-29 07:19:02 -04:00
|
|
|
/** @deprecated */
|
2016-06-24 20:35:01 -04:00
|
|
|
export declare class TestComponentBuilder {
|
|
|
|
|
protected _injector: Injector;
|
|
|
|
|
constructor(_injector: Injector);
|
2016-07-29 07:19:02 -04:00
|
|
|
createAsync<T>(rootComponentType: ConcreteType<T>): Promise<ComponentFixture<T>>;
|
|
|
|
|
createFakeAsync<T>(rootComponentType: ConcreteType<T>): ComponentFixture<T>;
|
2016-06-24 20:35:01 -04:00
|
|
|
protected createFromFactory<C>(ngZone: NgZone, componentFactory: ComponentFactory<C>): ComponentFixture<C>;
|
2016-07-29 07:19:02 -04:00
|
|
|
createSync<T>(rootComponentType: ConcreteType<T>): ComponentFixture<T>;
|
2016-06-24 20:35:01 -04:00
|
|
|
overrideAnimations(componentType: Type, animations: AnimationEntryMetadata[]): TestComponentBuilder;
|
|
|
|
|
overrideDirective(componentType: Type, from: Type, to: Type): TestComponentBuilder;
|
|
|
|
|
overrideProviders(type: Type, providers: any[]): TestComponentBuilder;
|
|
|
|
|
overrideTemplate(componentType: Type, template: string): TestComponentBuilder;
|
|
|
|
|
overrideView(componentType: Type, view: ViewMetadata): TestComponentBuilder;
|
|
|
|
|
overrideViewProviders(type: Type, providers: any[]): TestComponentBuilder;
|
|
|
|
|
}
|
|
|
|
|
|
2016-06-27 15:27:23 -04:00
|
|
|
/** @experimental */
|
2016-06-24 20:35:01 -04:00
|
|
|
export declare class TestComponentRenderer {
|
|
|
|
|
insertRootElement(rootElementId: string): void;
|
|
|
|
|
}
|
|
|
|
|
|
2016-06-27 15:27:23 -04:00
|
|
|
/** @experimental */
|
2016-07-29 07:19:02 -04:00
|
|
|
export declare type TestModuleMetadata = {
|
feat(testing): add implicit test module
Every test now has an implicit module. It can be configured via `configureModule` (from @angular/core/testing)
to add providers, directives, pipes, ...
The compiler now has to be configured separately via `configureCompiler` (from @angular/core/testing)
to add providers or define whether to use jit.
BREAKING CHANGE:
- Application providers can no longer inject compiler internals (i.e. everything
from `@angular/compiler). Inject `Compiler` instead. This reflects the
changes to `bootstrap` for module support (3f55aa609f60f130f1d69188ed057214b1267cb3).
- Compiler providers can no longer be added via `addProviders` / `withProviders`.
Use the new method `configureCompiler` instead.
- Platform directives / pipes need to be provided via
`configureModule` and can no longer be provided via the
`PLATFORM_PIPES` / `PLATFORM_DIRECTIVES` tokens.
- `setBaseTestProviders()` was renamed into `initTestEnvironment` and
now takes a `PlatformRef` and a factory for a
`Compiler`.
- E.g. for the browser platform:
BEFORE:
```
import {setBaseTestProviders} from ‘@angular/core/testing’;
import {TEST_BROWSER_DYNAMIC_PLATFORM_PROVIDERS,
TEST_BROWSER_DYNAMIC_APPLICATION_PROVIDERS} from ‘@angular/platform-browser-dynamic/testing’;
setBaseTestProviders(TEST_BROWSER_DYNAMIC_PLATFORM_PROVIDERS,
TEST_BROWSER_DYNAMIC_APPLICATION_PROVIDERS);
```
AFTER:
```
import {setBaseTestProviders} from ‘@angular/core/testing’;
import {browserTestCompiler, browserDynamicTestPlatform,
BrowserDynamicTestModule} from ‘@angular/platform-browser-dynamic/testing’;
initTestEnvironment(
browserTestCompiler,
browserDynamicTestPlatform(),
BrowserDynamicTestModule);
```
- E.g. for the server platform:
BEFORE:
```
import {setBaseTestProviders} from ‘@angular/core/testing’;
import {TEST_SERVER_PLATFORM_PROVIDERS,
TEST_SERVER_APPLICATION_PROVIDERS} from ‘@angular/platform-server/testing/server’;
setBaseTestProviders(TEST_SERVER_PLATFORM_PROVIDERS,
TEST_SERVER_APPLICATION_PROVIDERS);
```
AFTER:
```
import {setBaseTestProviders} from ‘@angular/core/testing’;
import {serverTestCompiler, serverTestPlatform,
ServerTestModule} from ‘@angular/platform-browser-dynamic/testing’;
initTestEnvironment(
serverTestCompiler,
serverTestPlatform(),
ServerTestModule);
```
Related to #9726
Closes #9846
2016-07-04 12:37:30 -04:00
|
|
|
providers?: any[];
|
2016-07-18 06:50:31 -04:00
|
|
|
declarations?: any[];
|
|
|
|
|
imports?: any[];
|
2016-07-25 08:47:16 -04:00
|
|
|
schemas?: Array<SchemaMetadata | any[]>;
|
2016-07-29 07:19:02 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/** @experimental */
|
|
|
|
|
export declare function tick(millis?: number): void;
|
feat(testing): add implicit test module
Every test now has an implicit module. It can be configured via `configureModule` (from @angular/core/testing)
to add providers, directives, pipes, ...
The compiler now has to be configured separately via `configureCompiler` (from @angular/core/testing)
to add providers or define whether to use jit.
BREAKING CHANGE:
- Application providers can no longer inject compiler internals (i.e. everything
from `@angular/compiler). Inject `Compiler` instead. This reflects the
changes to `bootstrap` for module support (3f55aa609f60f130f1d69188ed057214b1267cb3).
- Compiler providers can no longer be added via `addProviders` / `withProviders`.
Use the new method `configureCompiler` instead.
- Platform directives / pipes need to be provided via
`configureModule` and can no longer be provided via the
`PLATFORM_PIPES` / `PLATFORM_DIRECTIVES` tokens.
- `setBaseTestProviders()` was renamed into `initTestEnvironment` and
now takes a `PlatformRef` and a factory for a
`Compiler`.
- E.g. for the browser platform:
BEFORE:
```
import {setBaseTestProviders} from ‘@angular/core/testing’;
import {TEST_BROWSER_DYNAMIC_PLATFORM_PROVIDERS,
TEST_BROWSER_DYNAMIC_APPLICATION_PROVIDERS} from ‘@angular/platform-browser-dynamic/testing’;
setBaseTestProviders(TEST_BROWSER_DYNAMIC_PLATFORM_PROVIDERS,
TEST_BROWSER_DYNAMIC_APPLICATION_PROVIDERS);
```
AFTER:
```
import {setBaseTestProviders} from ‘@angular/core/testing’;
import {browserTestCompiler, browserDynamicTestPlatform,
BrowserDynamicTestModule} from ‘@angular/platform-browser-dynamic/testing’;
initTestEnvironment(
browserTestCompiler,
browserDynamicTestPlatform(),
BrowserDynamicTestModule);
```
- E.g. for the server platform:
BEFORE:
```
import {setBaseTestProviders} from ‘@angular/core/testing’;
import {TEST_SERVER_PLATFORM_PROVIDERS,
TEST_SERVER_APPLICATION_PROVIDERS} from ‘@angular/platform-server/testing/server’;
setBaseTestProviders(TEST_SERVER_PLATFORM_PROVIDERS,
TEST_SERVER_APPLICATION_PROVIDERS);
```
AFTER:
```
import {setBaseTestProviders} from ‘@angular/core/testing’;
import {serverTestCompiler, serverTestPlatform,
ServerTestModule} from ‘@angular/platform-browser-dynamic/testing’;
initTestEnvironment(
serverTestCompiler,
serverTestPlatform(),
ServerTestModule);
```
Related to #9726
Closes #9846
2016-07-04 12:37:30 -04:00
|
|
|
|
2016-06-27 15:27:23 -04:00
|
|
|
/** @experimental */
|
2016-07-29 07:19:02 -04:00
|
|
|
export declare function withModule(moduleDef: TestModuleMetadata): InjectSetupWrapper;
|
|
|
|
|
|
|
|
|
|
/** @deprecated */
|
2016-06-22 17:56:10 -04:00
|
|
|
export declare function withProviders(providers: () => any): InjectSetupWrapper;
|
