kernl API
    Preparing search index...

    Interface EventCache

    A place events are kept between visits. Every backend keeps the same rules: for a replaceable or addressable event only the newest version is kept, a deletion by the same author removes its targets and keeps them out, and ephemeral events are never stored (D-030).

    interface EventCache {
        name: string;
        add(events: readonly NostrEvent[]): Promise<void>;
        clear(): Promise<void>;
        close(): Promise<void>;
        query(filters: readonly Filter[]): Promise<NostrEvent[]>;
        removeByFilters(filters: readonly Filter[]): Promise<number>;
    }
    Index
    name
    add clear close query removeByFilters
    name: string

    Which backend this is: sqlite-opfs, indexeddb, memory, or a custom name.

    • Store events. Duplicates, older replaceable versions and deleted events are dropped.

      Parameters

      • events: readonly NostrEvent[]

      Returns Promise<void>

    • Remove every event.

      Returns Promise<void>

    • Release the backend. The cache is not used after this.

      Returns Promise<void>

    • Events matching any of the filters, newest first, each filter's limit applied to that filter.

      Parameters

      • filters: readonly Filter[]

      Returns Promise<NostrEvent[]>

    • Remove the events matching any of the filters; resolves how many were removed.

      Parameters

      • filters: readonly Filter[]

      Returns Promise<number>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods