84 lines
2.8 KiB
TypeScript
84 lines
2.8 KiB
TypeScript
|
import { UnidentifiedQueueStoreEntry, QueueStoreEntry } from './QueueDb.js';
|
||
|
|
import '../_version.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 QueueStore {
|
||
|
|
private readonly _queueName;
|
||
|
|
private readonly _queueDb;
|
||
|
|
/**
|
||
|
|
* Associates this instance with a Queue instance, so entries added can be
|
||
|
|
* identified by their queue name.
|
||
|
|
*
|
||
|
|
* @param {string} queueName
|
||
|
|
*/
|
||
|
|
constructor(queueName: string);
|
||
|
|
/**
|
||
|
|
* Append an entry last in the queue.
|
||
|
|
*
|
||
|
|
* @param {Object} entry
|
||
|
|
* @param {Object} entry.requestData
|
||
|
|
* @param {number} [entry.timestamp]
|
||
|
|
* @param {Object} [entry.metadata]
|
||
|
|
*/
|
||
|
|
pushEntry(entry: UnidentifiedQueueStoreEntry): Promise<void>;
|
||
|
|
/**
|
||
|
|
* Prepend an entry first in the queue.
|
||
|
|
*
|
||
|
|
* @param {Object} entry
|
||
|
|
* @param {Object} entry.requestData
|
||
|
|
* @param {number} [entry.timestamp]
|
||
|
|
* @param {Object} [entry.metadata]
|
||
|
|
*/
|
||
|
|
unshiftEntry(entry: UnidentifiedQueueStoreEntry): Promise<void>;
|
||
|
|
/**
|
||
|
|
* Removes and returns the last entry in the queue matching the `queueName`.
|
||
|
|
*
|
||
|
|
* @return {Promise<QueueStoreEntry|undefined>}
|
||
|
|
*/
|
||
|
|
popEntry(): Promise<QueueStoreEntry | undefined>;
|
||
|
|
/**
|
||
|
|
* Removes and returns the first entry in the queue matching the `queueName`.
|
||
|
|
*
|
||
|
|
* @return {Promise<QueueStoreEntry|undefined>}
|
||
|
|
*/
|
||
|
|
shiftEntry(): Promise<QueueStoreEntry | undefined>;
|
||
|
|
/**
|
||
|
|
* Returns all entries in the store matching the `queueName`.
|
||
|
|
*
|
||
|
|
* @param {Object} options See {@link workbox-background-sync.Queue~getAll}
|
||
|
|
* @return {Promise<Array<Object>>}
|
||
|
|
*/
|
||
|
|
getAll(): Promise<QueueStoreEntry[]>;
|
||
|
|
/**
|
||
|
|
* Returns the number of entries in the store matching the `queueName`.
|
||
|
|
*
|
||
|
|
* @param {Object} options See {@link workbox-background-sync.Queue~size}
|
||
|
|
* @return {Promise<number>}
|
||
|
|
*/
|
||
|
|
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 {number} 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`.
|
||
|
|
*
|
||
|
|
* @return {Promise<QueueStoreEntry|undefined>}
|
||
|
|
* @private
|
||
|
|
*/
|
||
|
|
_removeEntry(entry?: QueueStoreEntry): Promise<QueueStoreEntry | undefined>;
|
||
|
|
}
|