docs(platform-webworker): remove mention of version 10 (#37052)

The deprecation notice for platform-webworker
APIs is too prescriptive and notes that we will
remove the package in version 10. Since we are
not planning to do this for version 10, this
commit updates the notice to read "a future
version of Angular".

PR Close #37052
This commit is contained in:
Kara Erickson 2020-05-11 14:41:13 -07:00 committed by Misko Hevery
parent 2cddeabce0
commit d7c70caa4c
13 changed files with 47 additions and 24 deletions

View File

@ -16,7 +16,8 @@ export {VERSION} from './version';
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export const platformWorkerAppDynamic = export const platformWorkerAppDynamic =
createPlatformFactory(platformCoreDynamic, 'workerAppDynamic', [ createPlatformFactory(platformCoreDynamic, 'workerAppDynamic', [

View File

@ -16,6 +16,7 @@ import {Version} from '@angular/core';
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export const VERSION = new Version('0.0.0-PLACEHOLDER'); export const VERSION = new Version('0.0.0-PLACEHOLDER');

View File

@ -1,2 +1,2 @@
**Deprecated** This package is deprecated and will be removed in version 10. **Deprecated** This package is deprecated and will be removed in a future version of Angular.
See [Angular deprecations policy](guide/deprecations). See [Angular deprecations policy](guide/deprecations).

View File

@ -24,7 +24,8 @@ export {platformWorkerUi} from './worker_render';
* Bootstraps the worker ui. * Bootstraps the worker ui.
* *
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export function bootstrapWorkerUi( export function bootstrapWorkerUi(
workerScriptUri: string, customProviders: StaticProvider[] = []): Promise<PlatformRef> { workerScriptUri: string, customProviders: StaticProvider[] = []): Promise<PlatformRef> {

View File

@ -16,6 +16,7 @@ import {Version} from '@angular/core';
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export const VERSION = new Version('0.0.0-PLACEHOLDER'); export const VERSION = new Version('0.0.0-PLACEHOLDER');

View File

@ -12,7 +12,8 @@ import {Serializer, SerializerTypes} from './serializer';
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
@Injectable() @Injectable()
export class ClientMessageBrokerFactory { export class ClientMessageBrokerFactory {
@ -40,7 +41,8 @@ interface PromiseCompleter {
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export class ClientMessageBroker { export class ClientMessageBroker {
private _pending = new Map<string, PromiseCompleter>(); private _pending = new Map<string, PromiseCompleter>();
@ -146,7 +148,8 @@ interface ResponseMessageData {
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export class FnArg { export class FnArg {
constructor( constructor(
@ -155,7 +158,8 @@ export class FnArg {
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export class UiArguments { export class UiArguments {
constructor(public method: string, public args?: FnArg[]) {} constructor(public method: string, public args?: FnArg[]) {}

View File

@ -17,7 +17,8 @@ import {EventEmitter, NgZone} from '@angular/core';
* by the corresponding MessageBusSource. * by the corresponding MessageBusSource.
* *
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export abstract class MessageBus implements MessageBusSource, MessageBusSink { export abstract class MessageBus implements MessageBusSource, MessageBusSink {
/** /**
@ -53,7 +54,8 @@ export abstract class MessageBus implements MessageBusSource, MessageBusSink {
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export interface MessageBusSource { export interface MessageBusSource {
/** /**
@ -80,7 +82,8 @@ export interface MessageBusSource {
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export interface MessageBusSink { export interface MessageBusSink {
/** /**

View File

@ -12,7 +12,8 @@ import {RenderStore} from './render_store';
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export const enum SerializerTypes { export const enum SerializerTypes {
// RendererType2 // RendererType2

View File

@ -13,7 +13,8 @@ import {Serializer, SerializerTypes} from '../shared/serializer';
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
@Injectable() @Injectable()
export class ServiceMessageBrokerFactory { export class ServiceMessageBrokerFactory {
@ -41,7 +42,8 @@ export class ServiceMessageBrokerFactory {
* If that method returns a promise, the UIMessageBroker returns the result to the worker. * If that method returns a promise, the UIMessageBroker returns the result to the worker.
* *
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export class ServiceMessageBroker { export class ServiceMessageBroker {
private _sink: EventEmitter<any>; private _sink: EventEmitter<any>;
@ -93,7 +95,8 @@ export class ServiceMessageBroker {
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export interface ReceivedMessage { export interface ReceivedMessage {
method: string; method: string;

View File

@ -21,7 +21,8 @@ import {MessageBasedPlatformLocation} from './platform_location';
* A list of {@link Provider}s. To use the router in a Worker enabled application you must * A list of {@link Provider}s. To use the router in a Worker enabled application you must
* include these providers when setting up the render thread. * include these providers when setting up the render thread.
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export const WORKER_UI_LOCATION_PROVIDERS = <StaticProvider[]>[ export const WORKER_UI_LOCATION_PROVIDERS = <StaticProvider[]>[
{ {

View File

@ -17,7 +17,8 @@ import {WebWorkerPlatformLocation} from './platform_location';
* a worker context. * a worker context.
* *
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export const WORKER_APP_LOCATION_PROVIDERS: StaticProvider[] = [ export const WORKER_APP_LOCATION_PROVIDERS: StaticProvider[] = [
{provide: PlatformLocation, useClass: WebWorkerPlatformLocation} as any as StaticProvider, { {provide: PlatformLocation, useClass: WebWorkerPlatformLocation} as any as StaticProvider, {

View File

@ -22,7 +22,8 @@ import {WorkerDomAdapter} from './web_workers/worker/worker_adapter';
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export const platformWorkerApp: (extraProviders?: StaticProvider[]|undefined) => PlatformRef = export const platformWorkerApp: (extraProviders?: StaticProvider[]|undefined) => PlatformRef =
createPlatformFactory( createPlatformFactory(
@ -56,7 +57,8 @@ export function setupWebWorker(): void {
* The ng module for the worker app side. * The ng module for the worker app side.
* *
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
@NgModule({ @NgModule({
providers: [ providers: [

View File

@ -26,7 +26,8 @@ import {MessageBasedRenderer2} from './web_workers/ui/renderer';
* and underlying {@link MessageBus} for lower level message passing. * and underlying {@link MessageBus} for lower level message passing.
* *
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
@Injectable() @Injectable()
export class WebWorkerInstance { export class WebWorkerInstance {
@ -44,7 +45,8 @@ export class WebWorkerInstance {
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export const WORKER_SCRIPT = new InjectionToken<string>('WebWorkerScript'); export const WORKER_SCRIPT = new InjectionToken<string>('WebWorkerScript');
@ -53,7 +55,8 @@ export const WORKER_SCRIPT = new InjectionToken<string>('WebWorkerScript');
* created. * created.
* *
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export const WORKER_UI_STARTABLE_MESSAGING_SERVICE = export const WORKER_UI_STARTABLE_MESSAGING_SERVICE =
new InjectionToken<({start: () => void})[]>('WorkerRenderStartableMsgService'); new InjectionToken<({start: () => void})[]>('WorkerRenderStartableMsgService');
@ -154,7 +157,8 @@ function initWebWorkerRenderPlatform(injector: Injector): () => void {
/** /**
* @publicApi * @publicApi
* @deprecated platform-webworker is deprecated in Angular and will be removed in version 10 * @deprecated platform-webworker is deprecated in Angular and will be removed in a future version
* of Angular
*/ */
export const platformWorkerUi = export const platformWorkerUi =
createPlatformFactory(platformCore, 'workerUi', _WORKER_UI_PLATFORM_PROVIDERS); createPlatformFactory(platformCore, 'workerUi', _WORKER_UI_PLATFORM_PROVIDERS);