serwist/dist/lib/backgroundSync/BackgroundSyncQueueStore.d.ts

A Swiss Army knife for service workers.

import type { BackgroundSyncQueueStoreEntry, UnidentifiedQueueStoreEntry } from "./BackgroundSyncQueueDb.js";
/**
 * A class to manage storing requests from a Queue in IndexedDB,
 * indexed by their queue name for easier access.
 *
 * Most developers will not need to access this class directly;
 * it is exposed for advanced use cases.
 */
export declare class BackgroundSyncQueueStore {
    private readonly _queueName;
    private readonly _queueDb;
    /**
     * Associates this instance with a Queue instance, so entries added can be
     * identified by their queue name.
     *
     * @param queueName
     */
    constructor(queueName: string);
    /**
     * Append an entry last in the queue.
     *
     * @param entry
     */
    pushEntry(entry: UnidentifiedQueueStoreEntry): Promise<void>;
    /**
     * Prepend an entry first in the queue.
     *
     * @param entry
     */
    unshiftEntry(entry: UnidentifiedQueueStoreEntry): Promise<void>;
    /**
     * Removes and returns the last entry in the queue matching the `queueName`.
     *
     * @returns
     */
    popEntry(): Promise<BackgroundSyncQueueStoreEntry | undefined>;
    /**
     * Removes and returns the first entry in the queue matching the `queueName`.
     *
     * @returns
     */
    shiftEntry(): Promise<BackgroundSyncQueueStoreEntry | undefined>;
    /**
     * Returns all entries in the store matching the `queueName`.
     *
     * @returns
     */
    getAll(): Promise<BackgroundSyncQueueStoreEntry[]>;
    /**
     * Returns the number of entries in the store matching the `queueName`.
     *
     * @returns
     */
    size(): Promise<number>;
    /**
     * 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.
     *
     * @param id
     */
    deleteEntry(id: number): Promise<void>;
    /**
     * Removes and returns the first or last entry in the queue (based on the
     * `direction` argument) matching the `queueName`.
     *
     * @returns
     * @private
     */
    _removeEntry(entry?: BackgroundSyncQueueStoreEntry): Promise<BackgroundSyncQueueStoreEntry | undefined>;
}
//# sourceMappingURL=BackgroundSyncQueueStore.d.ts.map