angular-docs-cn/tools/public_api_guard/platform-browser/index.d.ts

247 lines
6.9 KiB
TypeScript
Raw Normal View History

/** @experimental */
export declare const _WORKER_UI_PLATFORM_PROVIDERS: Array<any>;
/** @experimental */
export declare abstract class AnimationDriver {
abstract animate(element: any, startingStyles: AnimationStyles, keyframes: AnimationKeyframe[], duration: number, delay: number, easing: string): AnimationPlayer;
static NOOP: AnimationDriver;
}
/** @deprecated */
export declare const BROWSER_APP_PROVIDERS: Array<any>;
/** @deprecated */
export declare const BROWSER_PLATFORM_PROVIDERS: Array<any>;
/** @experimental */
export declare const BROWSER_SANITIZATION_PROVIDERS: Array<any>;
refactor(core): clean up platform bootstrap and initTestEnvironment - Introduces `CompilerFactory` which can be part of a `PlatformRef`. - Introduces `WorkerAppModule`, `WorkerUiModule`, `ServerModule` - Introduces `serverDynamicPlatform` for applications using runtime compilation on the server. - Changes browser bootstrap for runtime and offline compilation (see below for an example). * introduces `bootstrapModule` and `bootstrapModuleFactory` in `@angular/core` * introduces new `browserDynamicPlatform` in `@angular/platform-browser-dynamic - Changes `initTestEnvironment` (which used to be `setBaseTestProviders`) to not take a compiler factory any more (see below for an example). BREAKING CHANGE: ## Migration from `setBaseTestProviders` to `initTestEnvironment`: - 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 {initTestEnvironment} from ‘@angular/core/testing’; import {browserDynamicTestPlatform, BrowserDynamicTestModule} from ‘@angular/platform-browser-dynamic/testing’; initTestEnvironment( BrowserDynamicTestModule, browserDynamicTestPlatform()); ``` - 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 {initTestEnvironment} from ‘@angular/core/testing’; import {serverTestPlatform, ServerTestModule} from ‘@angular/platform-browser-dynamic/testing’; initTestEnvironment( ServerTestModule, serverTestPlatform()); ``` ## Bootstrap changes ``` @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 {browserPlatform} from ‘@angular/platform-browser’; import {bootstrapModuleFactory} from ‘@angular/core’; bootstrapModuleFactory(MyModuleNgFactory, browserPlatform()); // runtime compile long form import {browserDynamicPlatform} from ‘@angular/platform-browser-dynamic’; import {bootstrapModule} from ‘@angular/core’; bootstrapModule(MyModule, browserDynamicPlatform()); ``` Closes #9922 Part of #9726
2016-07-08 13:47:17 -04:00
/** @experimental */
export declare class BrowserModule {
}
/** @deprecated */
export declare const browserPlatform: (extraProviders?: any[]) => PlatformRef;
/** @stable */
export declare class BrowserPlatformLocation extends PlatformLocation {
hash: string;
pathname: string;
search: string;
constructor();
back(): void;
forward(): void;
getBaseHrefFromDOM(): string;
onHashChange(fn: UrlChangeListener): void;
onPopState(fn: UrlChangeListener): void;
pushState(state: any, title: string, url: string): void;
replaceState(state: any, title: string, url: string): void;
}
/** @experimental */
export declare class By {
static all(): Predicate<DebugElement>;
static css(selector: string): Predicate<DebugElement>;
static directive(type: Type): Predicate<DebugElement>;
}
/** @experimental */
export declare abstract class ClientMessageBroker {
abstract runOnService(args: UiArguments, returnType: Type): Promise<any>;
}
/** @experimental */
export declare abstract class ClientMessageBrokerFactory {
abstract createMessageBroker(channel: string, runInZone?: boolean): ClientMessageBroker;
}
/** @experimental */
export declare function disableDebugTools(): void;
/** @stable */
export declare const DOCUMENT: OpaqueToken;
/** @stable */
export declare abstract class DomSanitizationService implements SanitizationService {
abstract bypassSecurityTrustHtml(value: string): SafeHtml;
abstract bypassSecurityTrustResourceUrl(value: string): SafeResourceUrl;
abstract bypassSecurityTrustScript(value: string): SafeScript;
abstract bypassSecurityTrustStyle(value: string): SafeStyle;
abstract bypassSecurityTrustUrl(value: string): SafeUrl;
abstract sanitize(context: SecurityContext, value: any): string;
}
/** @experimental */
export declare function enableDebugTools<T>(ref: ComponentRef<T>): ComponentRef<T>;
/** @stable */
export declare const EVENT_MANAGER_PLUGINS: OpaqueToken;
/** @stable */
export declare class EventManager {
constructor(plugins: EventManagerPlugin[], _zone: NgZone);
addEventListener(element: HTMLElement, eventName: string, handler: Function): Function;
addGlobalEventListener(target: string, eventName: string, handler: Function): Function;
getZone(): NgZone;
}
/** @experimental */
export declare class FnArg {
type: Type;
value: any;
constructor(value: any, type: Type);
}
/** @experimental */
export declare const HAMMER_GESTURE_CONFIG: OpaqueToken;
/** @experimental */
export declare class HammerGestureConfig {
events: string[];
overrides: {
[key: string]: Object;
};
buildHammer(element: HTMLElement): HammerInstance;
}
/** @experimental */
export declare abstract class MessageBus implements MessageBusSource, MessageBusSink {
abstract attachToZone(zone: NgZone): void;
abstract from(channel: string): EventEmitter<any>;
abstract initChannel(channel: string, runInZone?: boolean): void;
abstract to(channel: string): EventEmitter<any>;
}
/** @experimental */
export interface MessageBusSink {
attachToZone(zone: NgZone): void;
initChannel(channel: string, runInZone: boolean): void;
to(channel: string): EventEmitter<any>;
}
/** @experimental */
export interface MessageBusSource {
attachToZone(zone: NgZone): void;
from(channel: string): EventEmitter<any>;
initChannel(channel: string, runInZone: boolean): void;
}
/** @experimental */
export declare const platformBrowser: (extraProviders?: any[]) => PlatformRef;
/** @experimental */
export declare const platformWorkerApp: (extraProviders?: any[]) => PlatformRef;
/** @experimental */
export declare const platformWorkerUi: (extraProviders?: any[]) => PlatformRef;
/** @experimental */
export declare const PRIMITIVE: Type;
/** @experimental */
export declare class ReceivedMessage {
args: any[];
id: string;
method: string;
type: string;
constructor(data: {
[key: string]: any;
});
}
/** @stable */
export interface SafeHtml extends SafeValue {
}
/** @stable */
export interface SafeResourceUrl extends SafeValue {
}
/** @stable */
export interface SafeScript extends SafeValue {
}
/** @stable */
export interface SafeStyle extends SafeValue {
}
/** @stable */
export interface SafeUrl extends SafeValue {
}
/** @experimental */
export declare abstract class ServiceMessageBroker {
abstract registerMethod(methodName: string, signature: Type[], method: Function, returnType?: Type): void;
}
/** @experimental */
export declare abstract class ServiceMessageBrokerFactory {
abstract createMessageBroker(channel: string, runInZone?: boolean): ServiceMessageBroker;
}
/** @experimental */
export declare class Title {
getTitle(): string;
setTitle(newTitle: string): void;
}
/** @experimental */
export declare class UiArguments {
args: FnArg[];
method: string;
constructor(method: string, args?: FnArg[]);
}
/** @experimental */
export declare class WebWorkerInstance {
bus: MessageBus;
worker: Worker;
}
/** @deprecated */
export declare const WORKER_APP_APPLICATION_PROVIDERS: Array<any>;
/** @experimental */
export declare const WORKER_APP_LOCATION_PROVIDERS: ({
provide: typeof PlatformLocation;
useClass: typeof WebWorkerPlatformLocation;
} | {
provide: any;
useFactory: (platformLocation: WebWorkerPlatformLocation, zone: NgZone) => () => Promise<boolean>;
multi: boolean;
deps: (typeof PlatformLocation | typeof NgZone)[];
})[];
/** @deprecated */
export declare const WORKER_APP_PLATFORM_PROVIDERS: Array<any>;
/** @experimental */
export declare const WORKER_SCRIPT: OpaqueToken;
/** @deprecated */
export declare const WORKER_UI_APPLICATION_PROVIDERS: Array<any>;
/** @experimental */
export declare const WORKER_UI_LOCATION_PROVIDERS: (typeof MessageBasedPlatformLocation | typeof BrowserPlatformLocation | {
provide: any;
useFactory: (injector: Injector) => () => void;
multi: boolean;
deps: typeof Injector[];
})[];
/** @deprecated */
export declare const WORKER_UI_PLATFORM_PROVIDERS: Array<any>;
/** @experimental */
export declare const WORKER_UI_STARTABLE_MESSAGING_SERVICE: OpaqueToken;
/** @experimental */
refactor(core): clean up platform bootstrap and initTestEnvironment - Introduces `CompilerFactory` which can be part of a `PlatformRef`. - Introduces `WorkerAppModule`, `WorkerUiModule`, `ServerModule` - Introduces `serverDynamicPlatform` for applications using runtime compilation on the server. - Changes browser bootstrap for runtime and offline compilation (see below for an example). * introduces `bootstrapModule` and `bootstrapModuleFactory` in `@angular/core` * introduces new `browserDynamicPlatform` in `@angular/platform-browser-dynamic - Changes `initTestEnvironment` (which used to be `setBaseTestProviders`) to not take a compiler factory any more (see below for an example). BREAKING CHANGE: ## Migration from `setBaseTestProviders` to `initTestEnvironment`: - 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 {initTestEnvironment} from ‘@angular/core/testing’; import {browserDynamicTestPlatform, BrowserDynamicTestModule} from ‘@angular/platform-browser-dynamic/testing’; initTestEnvironment( BrowserDynamicTestModule, browserDynamicTestPlatform()); ``` - 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 {initTestEnvironment} from ‘@angular/core/testing’; import {serverTestPlatform, ServerTestModule} from ‘@angular/platform-browser-dynamic/testing’; initTestEnvironment( ServerTestModule, serverTestPlatform()); ``` ## Bootstrap changes ``` @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 {browserPlatform} from ‘@angular/platform-browser’; import {bootstrapModuleFactory} from ‘@angular/core’; bootstrapModuleFactory(MyModuleNgFactory, browserPlatform()); // runtime compile long form import {browserDynamicPlatform} from ‘@angular/platform-browser-dynamic’; import {bootstrapModule} from ‘@angular/core’; bootstrapModule(MyModule, browserDynamicPlatform()); ``` Closes #9922 Part of #9726
2016-07-08 13:47:17 -04:00
export declare class WorkerAppModule {
}
/** @deprecated */
export declare const workerAppPlatform: (extraProviders?: any[]) => PlatformRef;
/** @deprecated */
export declare const workerUiPlatform: (extraProviders?: any[]) => PlatformRef;