oro:shared-worker

oro:shared-worker/* exposes the shared-worker environment and runtime helpers.

Related guides#

• Shared workers across windows
• Windows and messaging

Examples#

Launch a shared worker and communicate through its shared port:

import { SharedWorker } from 'oro:shared-worker'

const worker = new SharedWorker(new URL('./shared.js', import.meta.url))

worker.port.start()
worker.port.postMessage({ type: 'warmup' })

API reference#

Module specifiers#

oro:shared-worker
oro:shared-worker/debug
oro:shared-worker/global
oro:shared-worker/index
oro:shared-worker/init
oro:shared-worker/state
oro:shared-worker/worker

TypeScript declarations#

These declarations are generated from the runtime's published TypeScript surface.

oro:shared-worker#

declare module "oro:shared-worker" {
    /**
     * A reference to the opened environment. This value is an instance of an
     * `Environment` if the scope is a ServiceWorker scope.
     * @type {Environment|null}
     */
    export const env: Environment | null;
    export default SharedWorker;
    import { SharedWorker } from "oro:shared-worker/index";
    export { Environment, SharedWorker };
}

oro:shared-worker/debug#

declare module "oro:shared-worker/debug" {
    export function debug(...args: any[]): void;
    export default debug;
}

oro:shared-worker/global#

declare module "oro:shared-worker/global" {
    export class SharedWorkerGlobalScope {
        get isSharedWorkerScope(): boolean;
        set onconnect(listener: any);
        get onconnect(): any;
    }
    const _default: SharedWorkerGlobalScope;
    export default _default;
}

oro:shared-worker/index#

declare module "oro:shared-worker/index" {
    export function init(sharedWorker: any, options: any): Promise<void>;
    /**
     * Gets the SharedWorker context window.
     * This function will create it if it does not already exist.
     * @return {Promise<import('./window.js').ApplicationWindow}
     */
    export function getContextWindow(): Promise<any>;
    export const SHARED_WORKER_WINDOW_TITLE: "oro:shared-worker";
    export const SHARED_WORKER_WINDOW_PATH: "/oro/shared-worker/index.html";
    export const channel: BroadcastChannel;
    export const workers: Map<any, any>;
    export class SharedWorkerMessagePort extends ipc.IPCMessagePort {
    }
    export class SharedWorker extends EventTarget {
        /**
         * `SharedWorker` class constructor.
         * @param {string|URL|Blob} aURL
         * @param {string|object=} [nameOrOptions]
         */
        constructor(aURL: string | URL | Blob, nameOrOptions?: (string | object) | undefined);
        set onerror(onerror: any);
        get onerror(): any;
        get ready(): any;
        get channel(): ipc.IPCMessageChannel;
        get port(): any;
        get id(): any;
        #private;
    }
    export default SharedWorker;
    import ipc from "oro:ipc";
}

oro:shared-worker/init#

declare module "oro:shared-worker/init" {
    export function onInstall(event: any): Promise<void>;
    export function onUninstall(event: any): Promise<void>;
    export function onConnect(event: any): Promise<void>;
    export const workers: Map<any, any>;
    export { channel };
    export class SharedWorkerInstance extends Worker {
        constructor(filename: any, options: any);
        get info(): any;
        onMessage(event: any): Promise<void>;
        #private;
    }
    export class SharedWorkerInfo {
        constructor(data: any);
        id: any;
        port: any;
        client: any;
        scriptURL: any;
        url: any;
        hash: any;
        get pathname(): string;
    }
    const _default: any;
    export default _default;
    import { channel } from "oro:shared-worker/index";
}

oro:shared-worker/state#

declare module "oro:shared-worker/state" {
    export const state: any;
    export default state;
}

oro:shared-worker/worker#

declare module "oro:shared-worker/worker" {
    export function onReady(): void;
    export function onMessage(event: any): Promise<void>;
    const _default: any;
    export default _default;
    export namespace SHARED_WORKER_READY_TOKEN {
        let __shared_worker_ready: boolean;
    }
    export namespace module {
        let exports: {};
    }
    export const connections: Set<any>;
}

See also#

• JavaScript APIs overview
• All module specifiers