Interface ServiceWorkerGlobalScope

This ServiceWorker API interface represents the global execution context of a service worker.

interface ServiceWorkerGlobalScope {
    AbortController: typeof AbortController;
    AbortSignal: typeof AbortSignal;
    Blob: typeof Blob;
    Body: typeof Body;
    ByteLengthQueuingStrategy: typeof ByteLengthQueuingStrategy;
    Cache: typeof Cache;
    CacheStorage: typeof CacheStorage;
    CloseEvent: typeof CloseEvent;
    CompressionStream: typeof CompressionStream;
    CountQueuingStrategy: typeof CountQueuingStrategy;
    Crypto: typeof Crypto;
    CryptoKey: typeof CryptoKey;
    CustomEvent: typeof CustomEvent;
    DOMException: typeof DOMException;
    DecompressionStream: typeof DecompressionStream;
    ErrorEvent: typeof ErrorEvent;
    Event: typeof Event;
    EventTarget: typeof EventTarget;
    ExtendableEvent: typeof ExtendableEvent;
    FetchEvent: typeof FetchEvent;
    File: typeof File;
    FixedLengthStream: typeof FixedLengthStream;
    FormData: typeof FormData;
    GPUAdapter: typeof gpuGPUAdapter;
    GPUBufferUsage: typeof gpuGPUBufferUsage;
    GPUColorWrite: typeof gpuGPUColorWrite;
    GPUDeviceLostInfo: typeof gpuGPUDeviceLostInfo;
    GPUInternalError: typeof gpuGPUInternalError;
    GPUMapMode: typeof gpuGPUMapMode;
    GPUOutOfMemoryError: typeof gpuGPUOutOfMemoryError;
    GPUShaderStage: typeof gpuGPUShaderStage;
    GPUTextureUsage: typeof gpuGPUTextureUsage;
    GPUValidationError: typeof gpuGPUValidationError;
    HTMLRewriter: typeof HTMLRewriter;
    Headers: typeof Headers;
    IdentityTransformStream: typeof IdentityTransformStream;
    MessageEvent: typeof MessageEvent;
    PromiseRejectionEvent: typeof PromiseRejectionEvent;
    ReadableStream: {
        prototype: ReadableStream<any>;
        new (underlyingSource, strategy?): ReadableStream<Uint8Array>;
        new <R>(underlyingSource?, strategy?): ReadableStream<R>;
    };
    ReadableStreamBYOBReader: typeof ReadableStreamBYOBReader;
    ReadableStreamDefaultReader: typeof ReadableStreamDefaultReader;
    Request: typeof Request;
    Response: typeof Response;
    ScheduledEvent: typeof ScheduledEvent;
    SubtleCrypto: typeof SubtleCrypto;
    TailEvent: typeof TailEvent;
    TextDecoder: typeof TextDecoder;
    TextDecoderStream: typeof TextDecoderStream;
    TextEncoder: typeof TextEncoder;
    TextEncoderStream: typeof TextEncoderStream;
    TraceEvent: typeof TailEvent;
    TransformStream: typeof TransformStream;
    URL: typeof URL;
    URLPattern: typeof URLPattern;
    URLSearchParams: typeof URLSearchParams;
    WebSocket: typeof WebSocket;
    WebSocketPair: (new () => {
        0: WebSocket;
        1: WebSocket;
    });
    WebSocketRequestResponsePair: typeof WebSocketRequestResponsePair;
    WorkerGlobalScope: typeof WorkerGlobalScope;
    WritableStream: typeof WritableStream;
    WritableStreamDefaultWriter: typeof WritableStreamDefaultWriter;
    caches: CacheStorage;
    crypto: Crypto;
    origin: string;
    performance: Performance;
    scheduler: Scheduler;
    self: ServiceWorkerGlobalScope;
    addEventListener<Type>(type, handler, options?): void;
    atob(data): string;
    btoa(data): string;
    clearInterval(timeoutId): void;
    clearTimeout(timeoutId): void;
    dispatchEvent(event): boolean;
    fetch(input, init?): Promise<Response>;
    queueMicrotask(task): void;
    removeEventListener<Type>(type, handler, options?): void;
    reportError(error): void;
    setInterval(callback, msDelay?): number;
    setInterval<Args>(callback, msDelay?, ...args): number;
    setTimeout(callback, msDelay?): number;
    setTimeout<Args>(callback, msDelay?, ...args): number;
    structuredClone<T>(value, options?): T;
}

Hierarchy (view full)

WorkerGlobalScope
- ServiceWorkerGlobalScope

Index

Properties

AbortController AbortSignal Blob Body ByteLengthQueuingStrategy Cache CacheStorage CloseEvent CompressionStream CountQueuingStrategy Crypto CryptoKey CustomEvent DOMException DecompressionStream ErrorEvent Event EventTarget ExtendableEvent FetchEvent File FixedLengthStream FormData GPUAdapter GPUBufferUsage GPUColorWrite GPUDeviceLostInfo GPUInternalError GPUMapMode GPUOutOfMemoryError GPUShaderStage GPUTextureUsage GPUValidationError HTMLRewriter Headers IdentityTransformStream MessageEvent PromiseRejectionEvent ReadableStream ReadableStreamBYOBReader ReadableStreamDefaultReader Request Response ScheduledEvent SubtleCrypto TailEvent TextDecoder TextDecoderStream TextEncoder TextEncoderStream TraceEvent TransformStream URL URLPattern URLSearchParams WebSocket WebSocketPair WebSocketRequestResponsePair WorkerGlobalScope WritableStream WritableStreamDefaultWriter caches crypto origin performance scheduler self

Methods

addEventListener atob btoa clearInterval clearTimeout dispatchEvent fetch queueMicrotask removeEventListener reportError setInterval setTimeout structuredClone

Properties

AbortController

AbortController: typeof AbortController

AbortSignal

AbortSignal: typeof AbortSignal

Blob

Blob: typeof Blob

Body

Body: typeof Body

ByteLengthQueuingStrategy

ByteLengthQueuingStrategy: typeof ByteLengthQueuingStrategy

Cache

Cache: typeof Cache

CacheStorage

CacheStorage: typeof CacheStorage

CloseEvent

CloseEvent: typeof CloseEvent

CompressionStream

CompressionStream: typeof CompressionStream

CountQueuingStrategy

CountQueuingStrategy: typeof CountQueuingStrategy

Crypto

Crypto: typeof Crypto

CryptoKey

CryptoKey: typeof CryptoKey

CustomEvent

CustomEvent: typeof CustomEvent

DOMException

DOMException: typeof DOMException

DecompressionStream

DecompressionStream: typeof DecompressionStream

ErrorEvent

ErrorEvent: typeof ErrorEvent

Event

Event: typeof Event

EventTarget

EventTarget: typeof EventTarget

ExtendableEvent

ExtendableEvent: typeof ExtendableEvent

FetchEvent

FetchEvent: typeof FetchEvent

File

File: typeof File

FixedLengthStream

FixedLengthStream: typeof FixedLengthStream

FormData

FormData: typeof FormData

GPUAdapter

GPUAdapter: typeof gpuGPUAdapter

GPUBufferUsage

GPUBufferUsage: typeof gpuGPUBufferUsage

GPUColorWrite

GPUColorWrite: typeof gpuGPUColorWrite

GPUDeviceLostInfo

GPUDeviceLostInfo: typeof gpuGPUDeviceLostInfo

GPUInternalError

GPUInternalError: typeof gpuGPUInternalError

GPUMapMode

GPUMapMode: typeof gpuGPUMapMode

GPUOutOfMemoryError

GPUOutOfMemoryError: typeof gpuGPUOutOfMemoryError

GPUShaderStage

GPUShaderStage: typeof gpuGPUShaderStage

GPUTextureUsage

GPUTextureUsage: typeof gpuGPUTextureUsage

GPUValidationError

GPUValidationError: typeof gpuGPUValidationError

HTMLRewriter

HTMLRewriter: typeof HTMLRewriter

Headers

Headers: typeof Headers

IdentityTransformStream

IdentityTransformStream: typeof IdentityTransformStream

MessageEvent

MessageEvent: typeof MessageEvent

PromiseRejectionEvent

PromiseRejectionEvent: typeof PromiseRejectionEvent

ReadableStream

ReadableStream: {
    prototype: ReadableStream<any>;
    new (underlyingSource, strategy?): ReadableStream<Uint8Array>;
    new <R>(underlyingSource?, strategy?): ReadableStream<R>;
}

Type declaration

- new (underlyingSource, strategy?): ReadableStream<Uint8Array>
- Parameters
  - underlyingSource: UnderlyingByteSource
  - Optional strategy: QueuingStrategy<Uint8Array>
  Returns ReadableStream<Uint8Array>
- new <R>(underlyingSource?, strategy?): ReadableStream<R>
- Type Parameters
  - R = any
  Parameters
  - Optional underlyingSource: UnderlyingSource<R>
  - Optional strategy: QueuingStrategy<R>
  Returns ReadableStream<R>
prototype: ReadableStream<any>

ReadableStreamBYOBReader

ReadableStreamBYOBReader: typeof ReadableStreamBYOBReader

ReadableStreamDefaultReader

ReadableStreamDefaultReader: typeof ReadableStreamDefaultReader

Request

Request: typeof Request

Response

Response: typeof Response

ScheduledEvent

ScheduledEvent: typeof ScheduledEvent

SubtleCrypto

SubtleCrypto: typeof SubtleCrypto

TailEvent

TailEvent: typeof TailEvent

TextDecoder

TextDecoder: typeof TextDecoder

TextDecoderStream

TextDecoderStream: typeof TextDecoderStream

TextEncoder

TextEncoder: typeof TextEncoder

TextEncoderStream

TextEncoderStream: typeof TextEncoderStream

TraceEvent

TraceEvent: typeof TailEvent

TransformStream

TransformStream: typeof TransformStream

URL

URL: typeof URL

URLPattern

URLPattern: typeof URLPattern

URLSearchParams

URLSearchParams: typeof URLSearchParams

WebSocket

WebSocket: typeof WebSocket

WebSocketPair

WebSocketPair: (new () => {
0: WebSocket;
1: WebSocket;
})

Type declaration

- new (): {
  0: WebSocket;
  1: WebSocket;
  }
- Returns {
  0: WebSocket;
  1: WebSocket;
  }
  - 0: WebSocket
  - 1: WebSocket

WebSocketRequestResponsePair

WebSocketRequestResponsePair: typeof WebSocketRequestResponsePair

WorkerGlobalScope

WorkerGlobalScope: typeof WorkerGlobalScope

WritableStream

WritableStream: typeof WritableStream

WritableStreamDefaultWriter

WritableStreamDefaultWriter: typeof WritableStreamDefaultWriter

caches

caches: CacheStorage

crypto

crypto: Crypto

`Readonly` origin

origin: string

performance

performance: Performance

scheduler

scheduler: Scheduler

self

self: ServiceWorkerGlobalScope

Methods

addEventListener

addEventListener<Type>(type, handler, options?): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Type Parameters
- Type extends keyof WorkerGlobalScopeEventMap
Parameters
- type: Type
- handler: EventListenerOrEventListenerObject<WorkerGlobalScopeEventMap[Type]>
- Optional options: boolean | EventTargetAddEventListenerOptions
Returns void
Inherited from WorkerGlobalScope.addEventListener
- Defined in index.ts:758

atob

atob(data): string
Parameters
- data: string
Returns string
- Defined in index.ts:204

btoa

btoa(data): string
Parameters
- data: string
Returns string
- Defined in index.ts:203

clearInterval

clearInterval(timeoutId): void
Parameters
- timeoutId: number
Returns void
- Defined in index.ts:218

clearTimeout

clearTimeout(timeoutId): void
Parameters
- timeoutId: number
Returns void
- Defined in index.ts:211

dispatchEvent

dispatchEvent(event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference
Parameters
- event: FetchEvent | ScheduledEvent | QueueEvent<unknown> | PromiseRejectionEvent
Returns boolean
Inherited from WorkerGlobalScope.dispatchEvent
- Defined in index.ts:778

fetch

fetch(input, init?): Promise<Response>
Parameters
- input: RequestInfo<unknown, CfProperties<unknown>>
- Optional init: RequestInit<RequestInitCfProperties>
Returns Promise<Response>
- Defined in index.ts:222

queueMicrotask

queueMicrotask(task): void
Parameters
- task: Function
Returns void
- Defined in index.ts:219

removeEventListener

removeEventListener<Type>(type, handler, options?): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Type Parameters
- Type extends keyof WorkerGlobalScopeEventMap
Parameters
- type: Type
- handler: EventListenerOrEventListenerObject<WorkerGlobalScopeEventMap[Type]>
- Optional options: boolean | EventTargetEventListenerOptions
Returns void
Inherited from WorkerGlobalScope.removeEventListener
- Defined in index.ts:768

reportError

reportError(error): void
Parameters
- error: any
Returns void
- Defined in index.ts:221

setInterval

setInterval(callback, msDelay?): number
Parameters
- callback: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional msDelay: number
Returns number
- Defined in index.ts:212
setInterval<Args>(callback, msDelay?, ...args): number
Type Parameters
- Args extends any[]
Parameters
- callback: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: Args
      Returns void
- Optional msDelay: number
- Rest ...args: Args
Returns number
- Defined in index.ts:213

setTimeout

setTimeout(callback, msDelay?): number
Parameters
- callback: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional msDelay: number
Returns number
- Defined in index.ts:205
setTimeout<Args>(callback, msDelay?, ...args): number
Type Parameters
- Args extends any[]
Parameters
- callback: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: Args
      Returns void
- Optional msDelay: number
- Rest ...args: Args
Returns number
- Defined in index.ts:206

structuredClone

structuredClone<T>(value, options?): T
Type Parameters
- T
Parameters
- value: T
- Optional options: StructuredSerializeOptions
Returns T
- Defined in index.ts:220

Interface ServiceWorkerGlobalScope

Hierarchy (view full)

Index

Properties

Methods

Properties

AbortController

AbortSignal

Blob

Body

ByteLengthQueuingStrategy

Cache

CacheStorage

CloseEvent

CompressionStream

CountQueuingStrategy

Crypto

CryptoKey

CustomEvent

DOMException

DecompressionStream

ErrorEvent

Event

EventTarget

ExtendableEvent

FetchEvent

File

FixedLengthStream

FormData

GPUAdapter

GPUBufferUsage

GPUColorWrite

GPUDeviceLostInfo

GPUInternalError

GPUMapMode

GPUOutOfMemoryError

GPUShaderStage

GPUTextureUsage

GPUValidationError

HTMLRewriter

Headers

IdentityTransformStream

MessageEvent

PromiseRejectionEvent

ReadableStream

Type declaration

Parameters

Returns ReadableStream<Uint8Array>

Type Parameters

Parameters

Returns ReadableStream<R>

prototype: ReadableStream<any>

ReadableStreamBYOBReader

ReadableStreamDefaultReader

Request

Response

ScheduledEvent

SubtleCrypto

TailEvent

TextDecoder

TextDecoderStream

TextEncoder

TextEncoderStream

TraceEvent

TransformStream

URL

URLPattern

URLSearchParams

WebSocket

WebSocketPair

Type declaration

Returns { 0: WebSocket; 1: WebSocket; }

0: WebSocket

1: WebSocket

WebSocketRequestResponsePair

WorkerGlobalScope

WritableStream

WritableStreamDefaultWriter

caches

crypto

Returns {
0: WebSocket;
1: WebSocket;
}

`Readonly` origin