From a67cb92e6b9f3ff7375d58169c1bd834a14198c3 Mon Sep 17 00:00:00 2001 From: George Kalpakas Date: Thu, 14 Nov 2019 15:56:36 +0200 Subject: [PATCH] docs(platform-webworker): mark all public APIs as deprecated (#33824) In ccc76f749, `@angular/platform-webworker` and `@angular/platform-webworker-dynamic` were deprecated (i.e. by deprecating all their public APIs). However, some public `@angular/platform-webworker` APIs were accidentally missed, additionally resulting in the package itself not showing up as deprecated on angular.io. This commit fixes it by marking those remaining public APIs as deprecated. PR Close #33824 --- .../src/web_workers/shared/client_message_broker.ts | 2 ++ .../platform-webworker/src/web_workers/shared/message_bus.ts | 2 ++ packages/platform-webworker/src/worker_render.ts | 1 + .../platform-webworker/platform-webworker.d.ts | 5 +++++ 4 files changed, 10 insertions(+) diff --git a/packages/platform-webworker/src/web_workers/shared/client_message_broker.ts b/packages/platform-webworker/src/web_workers/shared/client_message_broker.ts index 0a79ccd883..269af61964 100644 --- a/packages/platform-webworker/src/web_workers/shared/client_message_broker.ts +++ b/packages/platform-webworker/src/web_workers/shared/client_message_broker.ts @@ -144,6 +144,7 @@ interface ResponseMessageData { /** * @publicApi + * @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 */ export class FnArg { constructor( @@ -152,6 +153,7 @@ export class FnArg { /** * @publicApi + * @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 */ export class UiArguments { constructor(public method: string, public args?: FnArg[]) {} diff --git a/packages/platform-webworker/src/web_workers/shared/message_bus.ts b/packages/platform-webworker/src/web_workers/shared/message_bus.ts index 3afa95f327..312d72039c 100644 --- a/packages/platform-webworker/src/web_workers/shared/message_bus.ts +++ b/packages/platform-webworker/src/web_workers/shared/message_bus.ts @@ -53,6 +53,7 @@ export abstract class MessageBus implements MessageBusSource, MessageBusSink { /** * @publicApi + * @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 */ export interface MessageBusSource { /** @@ -79,6 +80,7 @@ export interface MessageBusSource { /** * @publicApi + * @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 */ export interface MessageBusSink { /** diff --git a/packages/platform-webworker/src/worker_render.ts b/packages/platform-webworker/src/worker_render.ts index 5c8081b27c..39930cf745 100644 --- a/packages/platform-webworker/src/worker_render.ts +++ b/packages/platform-webworker/src/worker_render.ts @@ -150,6 +150,7 @@ function initWebWorkerRenderPlatform(injector: Injector): () => void { /** * @publicApi + * @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 */ export const platformWorkerUi = createPlatformFactory(platformCore, 'workerUi', _WORKER_UI_PLATFORM_PROVIDERS); diff --git a/tools/public_api_guard/platform-webworker/platform-webworker.d.ts b/tools/public_api_guard/platform-webworker/platform-webworker.d.ts index 09bb337566..cdb0e2fcba 100644 --- a/tools/public_api_guard/platform-webworker/platform-webworker.d.ts +++ b/tools/public_api_guard/platform-webworker/platform-webworker.d.ts @@ -11,6 +11,7 @@ export declare class ClientMessageBrokerFactory { createMessageBroker(channel: string, runInZone?: boolean): ClientMessageBroker; } +/** @deprecated */ export declare class FnArg { type: Type | SerializerTypes; value: any; @@ -25,12 +26,14 @@ export declare abstract class MessageBus implements MessageBusSource, MessageBus abstract to(channel: string): EventEmitter; } +/** @deprecated */ export interface MessageBusSink { attachToZone(zone: NgZone): void; initChannel(channel: string, runInZone: boolean): void; to(channel: string): EventEmitter; } +/** @deprecated */ export interface MessageBusSource { attachToZone(zone: NgZone): void; from(channel: string): EventEmitter; @@ -40,6 +43,7 @@ export interface MessageBusSource { /** @deprecated */ export declare const platformWorkerApp: (extraProviders?: StaticProvider[] | undefined) => PlatformRef; +/** @deprecated */ export declare const platformWorkerUi: (extraProviders?: StaticProvider[] | undefined) => import("@angular/core").PlatformRef; /** @deprecated */ @@ -67,6 +71,7 @@ export declare class ServiceMessageBrokerFactory { createMessageBroker(channel: string, runInZone?: boolean): ServiceMessageBroker; } +/** @deprecated */ export declare class UiArguments { args?: FnArg[] | undefined; method: string;