Interface EventRecords

The storage a backend provides. It only keeps rows; every rule about which event wins lives in createEventCache, so all backends behave the same.

interface EventRecords {
    clear(): Promise<void>;
    close(): Promise<void>;
    put(events: readonly NostrEvent[]): Promise<void>;
    query(filter: Filter): Promise<NostrEvent[]>;
    remove(ids: readonly string[]): Promise<void>;
}

Index

Methods

clear close put query remove

Methods

clear

clear(): Promise<void>

Returns Promise<void>

close

close(): Promise<void>

Returns Promise<void>

put

put(events: readonly NostrEvent[]): Promise<void>
Insert events, ignoring ids already present.
Parameters
- events: readonly NostrEvent[]
Returns Promise<void>

query

query(filter: Filter): Promise<NostrEvent[]>
Events matching one filter. Honouring limit is an optimisation; the caller applies it again.
Parameters
- filter: Filter
Returns Promise<NostrEvent[]>

remove

remove(ids: readonly string[]): Promise<void>
Remove events by id.
Parameters
- ids: readonly string[]
Returns Promise<void>