workbox-background-sync

The constructor function looks like: (name: string, options?: QueueOptions) => {...}

Creates an instance of Queue with the given options

The constructor function looks like: (name: string, options?: QueueOptions) => {...}

Returns all the entries that have not expired (per maxRetentionTime). Any expired entries are removed from the queue.

The getAll function looks like: () => {...}

Removes and returns the last request in the queue (along with its timestamp and any metadata). The returned object takes the form: {request, timestamp, metadata}.

The popRequest function looks like: () => {...}

Stores the passed request in IndexedDB (with its timestamp and any metadata) at the end of the queue.

The pushRequest function looks like: (entry: QueueEntry) => {...}

Registers a sync event with a tag unique to this instance.

The registerSync function looks like: () => {...}

Loops through each request in the queue and attempts to re-fetch it. If any request fails to re-fetch, it's put back in the same position in the queue (which registers a retry for the next sync event).

The replayRequests function looks like: () => {...}

Removes and returns the first request in the queue (along with its timestamp and any metadata). The returned object takes the form: {request, timestamp, metadata}.

The shiftRequest function looks like: () => {...}

Returns the number of entries present in the queue. Note that expired entries (per maxRetentionTime) are also included in this count.

The size function looks like: () => {...}

Stores the passed request in IndexedDB (with its timestamp and any metadata) at the beginning of the queue.

The unshiftRequest function looks like: (entry: QueueEntry) => {...}

Associates this instance with a Queue instance, so entries added can be identified by their queue name.

The constructor function looks like: (queueName: string) => {...}

Deletes the entry for the given ID.

WARNING: this method does not ensure the deleted entry belongs to this queue (i.e. matches the queueName). But this limitation is acceptable as this class is not publicly exposed. An additional check would make this method slower than it needs to be.

The deleteEntry function looks like: (id: number) => {...}

Returns all entries in the store matching the queueName.

The getAll function looks like: () => {...}

Removes and returns the last entry in the queue matching the queueName.

The popEntry function looks like: () => {...}

Append an entry last in the queue.

The pushEntry function looks like: (entry: UnidentifiedQueueStoreEntry) => {...}

Removes and returns the first entry in the queue matching the queueName.

The shiftEntry function looks like: () => {...}

Returns the number of entries in the store matching the queueName.

The size function looks like: () => {...}

Prepend an entry first in the queue.

The unshiftEntry function looks like: (entry: UnidentifiedQueueStoreEntry) => {...}

Accepts an object of request data that can be used to construct a Request but can also be stored in IndexedDB.

The constructor function looks like: (requestData: RequestData) => {...}

Creates and returns a deep clone of the instance.

The clone function looks like: () => {...}

Returns a deep clone of the instances _requestData object.

The toObject function looks like: () => {...}

Converts this instance to a Request.

The toRequest function looks like: () => {...}

Converts a Request object to a plain object that can be structured cloned or JSON-stringified.

The fromRequest function looks like: (request: Request) => {...}