Interface Clients

Provides access to Client objects. Access it via self.clients within a service worker.

interface Clients {
    claim(): Promise<void>;
    get(id: string): Promise<Client>;
    matchAll<T extends ClientQueryOptions>(
        options?: T,
    ): Promise<readonly (T["type"] extends "window" ? WindowClient : Client)[]>;
    openWindow(url: string | URL): Promise<WindowClient>;
}

Index

Methods

claim get matchAll openWindow

Methods

claim

claim(): Promise<void>
MDN Reference

Returns Promise<void>

get

get(id: string): Promise<Client>
MDN Reference
Parameters
- id: string
Returns Promise<Client>

matchAll

matchAll<T extends ClientQueryOptions>(
options?: T,
): Promise<readonly (T["type"] extends "window" ? WindowClient : Client)[]>
MDN Reference
Type Parameters
- T extends ClientQueryOptions
Parameters
- Optionaloptions: T
Returns Promise<readonly (T["type"] extends "window" ? WindowClient : Client)[]>

openWindow

openWindow(url: string | URL): Promise<WindowClient>
MDN Reference
Parameters
- url: string | URL
Returns Promise<WindowClient>