@adcp/sdk API Reference - v10.0.1
    Preparing search index...

    Interface CursorStore

    Abstraction for persisting the event feed cursor between restarts.

    interface CursorStore {
        getCursor(): Promise<string | null>;
        setCursor(cursor: string): Promise<void>;
        clearCursor(): Promise<void>;
    }

    Implemented by

    Index

    Methods

    • Remove the persisted cursor. Used by sync engines on RETENTION_EXPIRED recovery — the agent no longer holds events for our cursor, so we re-bootstrap and want subsequent getCursor() calls to return null.

      Implementations may delete the underlying storage (file) or store a sentinel value, as long as getCursor() returns null afterward.

      Returns Promise<void>