@segment/analytics-react-native/lib/typescript/src/plugins/QueueFlushingPlugin.d.ts

The hassle-free way to add Segment analytics to your React-Native app.

import type { SegmentClient } from '../analytics';
import { UtilityPlugin } from '../plugin';
import { PluginType, SegmentEvent } from '../types';
/**
 * This plugin manages a queue where all events get added to after timeline processing.
 * It takes a onFlush callback to trigger any action particular to your destination sending events.
 * It can autotrigger a flush of the queue when it reaches the config flushAt limit.
 */
export declare class QueueFlushingPlugin extends UtilityPlugin {
    type: PluginType;
    private storeKey;
    private queueStore;
    private onFlush;
    private isRestoredResolve;
    private isRestored;
    private timeoutWarned;
    private flushPromise?;
    /**
     * @param onFlush callback to execute when the queue is flushed (either by reaching the limit or manually) e.g. code to upload events to your destination
     * @param storeKey key to store the queue in the store. Must be unique per destination instance
     * @param restoreTimeout time in ms to wait for the queue to be restored from the store before uploading events (default: 500ms)
     */
    constructor(onFlush: (events: SegmentEvent[]) => Promise<void>, storeKey?: string, restoreTimeout?: number);
    configure(analytics: SegmentClient): void;
    execute(event: SegmentEvent): Promise<SegmentEvent | undefined>;
    /**
     * Calls the onFlush callback with the events in the queue.
     * Ensures only one flush operation runs at a time.
     */
    flush(): Promise<void>;
    private _doFlush;
    dequeueByMessageIds(messageIds: string[]): Promise<void>;
    /**
     * Clear all events from the queue
     */
    dequeueEvents(): Promise<void>;
    /**
     * * Returns the count of items in the queue
     */
    pendingEvents(): Promise<number>;
}
//# sourceMappingURL=QueueFlushingPlugin.d.ts.map