angular-cn/tools/public_api_guard/platform-webworker/index.d.ts

105 lines
3.2 KiB
TypeScript
Raw Normal View History

/** @experimental */
export declare function bootstrapWorkerUi(workerScriptUri: string, customProviders?: StaticProvider[]): Promise<PlatformRef>;
/** @experimental */
export declare abstract class ClientMessageBroker {
abstract runOnService(args: UiArguments, returnType: Type<any> | SerializerTypes | null): Promise<any> | null;
}
/** @experimental */
export declare abstract class ClientMessageBrokerFactory {
abstract createMessageBroker(channel: string, runInZone?: boolean): ClientMessageBroker;
}
/** @experimental */
export declare class FnArg {
type: Type<any> | SerializerTypes;
value: any;
constructor(value: any, type?: Type<any> | SerializerTypes);
}
/** @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 platformWorkerApp: (extraProviders?: StaticProvider[] | undefined) => PlatformRef;
/** @experimental */
export declare const platformWorkerUi: (extraProviders?: StaticProvider[] | undefined) => PlatformRef;
/** @experimental */
2017-02-19 03:23:45 -05:00
export interface ReceivedMessage {
args: any[];
id: string;
method: string;
type: string;
}
/** @experimental */
export declare const enum SerializerTypes {
RENDERER_TYPE_2 = 0,
2017-02-19 03:23:45 -05:00
PRIMITIVE = 1,
RENDER_STORE_OBJECT = 2,
}
/** @experimental */
export declare abstract class ServiceMessageBroker {
abstract registerMethod(methodName: string, signature: Array<Type<any> | SerializerTypes> | null, method: Function, returnType?: Type<any> | SerializerTypes): void;
}
/** @experimental */
export declare abstract class ServiceMessageBrokerFactory {
abstract createMessageBroker(channel: string, runInZone?: boolean): ServiceMessageBroker;
}
/** @experimental */
export declare class UiArguments {
args: FnArg[] | undefined;
method: string;
constructor(method: string, args?: FnArg[] | undefined);
}
/** @stable */
export declare const VERSION: Version;
/** @experimental */
export declare const WORKER_APP_LOCATION_PROVIDERS: ({
provide: typeof PlatformLocation;
useClass: typeof WebWorkerPlatformLocation;
} | {
feat(core): Add type information to injector.get() (#13785) - Introduce `InjectionToken<T>` which is a parameterized and type-safe version of `OpaqueToken`. DEPRECATION: - `OpaqueToken` is now deprecated, use `InjectionToken<T>` instead. - `Injector.get(token: any, notFoundValue?: any): any` is now deprecated use the same method which is now overloaded as `Injector.get<T>(token: Type<T>|InjectionToken<T>, notFoundValue?: T): T;`. Migration - Replace `OpaqueToken` with `InjectionToken<?>` and parameterize it. - Migrate your code to only use `Type<?>` or `InjectionToken<?>` as injection tokens. Using other tokens will not be supported in the future. BREAKING CHANGE: - Because `injector.get()` is now parameterize it is possible that code which used to work no longer type checks. Example would be if one injects `Foo` but configures it as `{provide: Foo, useClass: MockFoo}`. The injection instance will be that of `MockFoo` but the type will be `Foo` instead of `any` as in the past. This means that it was possible to call a method on `MockFoo` in the past which now will fail type check. See this example: ``` class Foo {} class MockFoo extends Foo { setupMock(); } var PROVIDERS = [ {provide: Foo, useClass: MockFoo} ]; ... function myTest(injector: Injector) { var foo = injector.get(Foo); // This line used to work since `foo` used to be `any` before this // change, it will now be `Foo`, and `Foo` does not have `setUpMock()`. // The fix is to downcast: `injector.get(Foo) as MockFoo`. foo.setUpMock(); } ``` PR Close #13785
2017-01-03 19:54:46 -05:00
provide: InjectionToken<(() => void)[]>;
useFactory: (platformLocation: WebWorkerPlatformLocation, zone: NgZone) => () => Promise<boolean>;
multi: boolean;
deps: (typeof NgZone | typeof PlatformLocation)[];
} | {
provide: InjectionToken<Promise<any>>;
useFactory: (platformLocation: WebWorkerPlatformLocation) => Promise<any>;
deps: typeof PlatformLocation[];
})[];
/** @experimental */
export declare const WORKER_UI_LOCATION_PROVIDERS: StaticProvider[];
/** @experimental */
export declare class WorkerAppModule {
}