matrix-js-sdk/lib/store/indexeddb-store-worker.d.ts

Matrix Client-Server SDK for Javascript

/**
 * This class lives in the webworker and drives a LocalIndexedDBStoreBackend
 * controlled by messages from the main process.
 *
 * @example
 * It should be instantiated by a web worker script provided by the application
 * in a script, for example:
 * ```
 * import {IndexedDBStoreWorker} from 'matrix-js-sdk/lib/indexeddb-worker.js';
 * const remoteWorker = new IndexedDBStoreWorker(postMessage);
 * onmessage = remoteWorker.onMessage;
 * ```
 *
 * Note that it is advisable to import this class by referencing the file directly to
 * avoid a dependency on the whole js-sdk.
 *
 */
export declare class IndexedDBStoreWorker {
    private readonly postMessage;
    private backend?;
    /**
     * @param postMessage - The web worker postMessage function that
     * should be used to communicate back to the main script.
     */
    constructor(postMessage: InstanceType<typeof Worker>["postMessage"]);
    /**
     * Passes a message event from the main script into the class. This method
     * can be directly assigned to the web worker `onmessage` variable.
     *
     * @param ev - The message event
     */
    onMessage: (ev: MessageEvent) => void;
}
//# sourceMappingURL=indexeddb-store-worker.d.ts.map