docs: convert all @experimental
tags to @publicApi
tags (#26595)
PR Close #26595
This commit is contained in:

committed by
Alex Rickabaugh

parent
4bd9f53e8f
commit
24521f549c
@ -23,7 +23,7 @@ export {platformWorkerUi} from './worker_render';
|
||||
/**
|
||||
* Bootstraps the worker ui.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export function bootstrapWorkerUi(
|
||||
workerScriptUri: string, customProviders: StaticProvider[] = []): Promise<PlatformRef> {
|
||||
|
@ -11,7 +11,7 @@ import {MessageBus} from './message_bus';
|
||||
import {Serializer, SerializerTypes} from './serializer';
|
||||
|
||||
/**
|
||||
* @experimental WebWorker support in Angular is experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
@Injectable()
|
||||
export class ClientMessageBrokerFactory {
|
||||
@ -38,7 +38,7 @@ interface PromiseCompleter {
|
||||
}
|
||||
|
||||
/**
|
||||
* @experimental WebWorker support in Angular is experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
export class ClientMessageBroker {
|
||||
private _pending = new Map<string, PromiseCompleter>();
|
||||
@ -141,7 +141,7 @@ interface ResponseMessageData {
|
||||
}
|
||||
|
||||
/**
|
||||
* @experimental WebWorker support in Angular is experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
export class FnArg {
|
||||
constructor(
|
||||
@ -149,7 +149,7 @@ export class FnArg {
|
||||
}
|
||||
|
||||
/**
|
||||
* @experimental WebWorker support in Angular is experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
export class UiArguments {
|
||||
constructor(public method: string, public args?: FnArg[]) {}
|
||||
|
@ -16,7 +16,7 @@ import {EventEmitter, NgZone} from '@angular/core';
|
||||
* given channel to one MessageBusSink are received on the same channel
|
||||
* by the corresponding MessageBusSource.
|
||||
*
|
||||
* @experimental WebWorker support in Angular is currenlty experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
export abstract class MessageBus implements MessageBusSource, MessageBusSink {
|
||||
/**
|
||||
@ -51,7 +51,7 @@ export abstract class MessageBus implements MessageBusSource, MessageBusSink {
|
||||
}
|
||||
|
||||
/**
|
||||
* @experimental WebWorker support in Angular is currenlty experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
export interface MessageBusSource {
|
||||
/**
|
||||
@ -77,7 +77,7 @@ export interface MessageBusSource {
|
||||
}
|
||||
|
||||
/**
|
||||
* @experimental WebWorker support in Angular is currenlty experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
export interface MessageBusSink {
|
||||
/**
|
||||
|
@ -11,7 +11,7 @@ import {RenderStore} from './render_store';
|
||||
|
||||
|
||||
/**
|
||||
* @experimental WebWorker support in Angular is currently experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
export const enum SerializerTypes {
|
||||
// RendererType2
|
||||
|
@ -12,7 +12,7 @@ import {Serializer, SerializerTypes} from '../shared/serializer';
|
||||
|
||||
|
||||
/**
|
||||
* @experimental WebWorker support in Angular is currently experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
@Injectable()
|
||||
export class ServiceMessageBrokerFactory {
|
||||
@ -39,7 +39,7 @@ export class ServiceMessageBrokerFactory {
|
||||
* the UIMessageBroker deserializes its arguments and calls the registered method.
|
||||
* If that method returns a promise, the UIMessageBroker returns the result to the worker.
|
||||
*
|
||||
* @experimental WebWorker support in Angular is currently experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
export class ServiceMessageBroker {
|
||||
private _sink: EventEmitter<any>;
|
||||
@ -90,7 +90,7 @@ export class ServiceMessageBroker {
|
||||
}
|
||||
|
||||
/**
|
||||
* @experimental WebWorker support in Angular is currently experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
export interface ReceivedMessage {
|
||||
method: string;
|
||||
|
@ -21,7 +21,7 @@ import {MessageBasedPlatformLocation} from './platform_location';
|
||||
/**
|
||||
* 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.
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export const WORKER_UI_LOCATION_PROVIDERS = <StaticProvider[]>[
|
||||
{provide: MessageBasedPlatformLocation, deps: [ServiceMessageBrokerFactory,
|
||||
|
@ -16,7 +16,7 @@ import {WebWorkerPlatformLocation} from './platform_location';
|
||||
* The {@link PlatformLocation} providers that should be added when the {@link Location} is used in
|
||||
* a worker context.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export const WORKER_APP_LOCATION_PROVIDERS = [
|
||||
{provide: PlatformLocation, useClass: WebWorkerPlatformLocation}, {
|
||||
|
@ -23,7 +23,7 @@ import {WorkerDomAdapter} from './web_workers/worker/worker_adapter';
|
||||
|
||||
|
||||
/**
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export const platformWorkerApp = createPlatformFactory(
|
||||
platformCore, 'workerApp', [{provide: PLATFORM_ID, useValue: PLATFORM_WORKER_APP_ID}]);
|
||||
@ -55,7 +55,7 @@ export function setupWebWorker(): void {
|
||||
/**
|
||||
* The ng module for the worker app side.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
@NgModule({
|
||||
providers: [
|
||||
|
@ -25,7 +25,7 @@ import {MessageBasedRenderer2} from './web_workers/ui/renderer';
|
||||
* Wrapper class that exposes the Worker
|
||||
* and underlying {@link MessageBus} for lower level message passing.
|
||||
*
|
||||
* @experimental WebWorker support is currently experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
@Injectable()
|
||||
export class WebWorkerInstance {
|
||||
@ -42,7 +42,7 @@ export class WebWorkerInstance {
|
||||
}
|
||||
|
||||
/**
|
||||
* @experimental WebWorker support is currently experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
export const WORKER_SCRIPT = new InjectionToken<string>('WebWorkerScript');
|
||||
|
||||
@ -50,7 +50,7 @@ export const WORKER_SCRIPT = new InjectionToken<string>('WebWorkerScript');
|
||||
* A multi-provider used to automatically call the `start()` method after the service is
|
||||
* created.
|
||||
*
|
||||
* @experimental WebWorker support is currently experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
export const WORKER_UI_STARTABLE_MESSAGING_SERVICE =
|
||||
new InjectionToken<({start: () => void})[]>('WorkerRenderStartableMsgService');
|
||||
@ -146,7 +146,7 @@ function initWebWorkerRenderPlatform(injector: Injector): () => void {
|
||||
}
|
||||
|
||||
/**
|
||||
* @experimental WebWorker support is currently experimental.
|
||||
* @publicApi
|
||||
*/
|
||||
export const platformWorkerUi =
|
||||
createPlatformFactory(platformCore, 'workerUi', _WORKER_UI_PLATFORM_PROVIDERS);
|
||||
|
Reference in New Issue
Block a user