Class QueryStore

constructor

• new QueryStore(store): QueryStore

• Parameters

  • store: EventStore

  Returns QueryStore

queries

store

StaticQueries

event

• event(id): Observable<undefined | Event>

• Returns a single event

  Parameters

  • id: string

  Returns Observable<undefined | Event>

events

• events(ids): Observable<Map<string, Event>>

• Returns a single event

  Parameters

  • ids: string[]

  Returns Observable<Map<string, Event>>

mailboxes

• mailboxes(pubkey): Observable<undefined | {
      inboxes: string[];
      outboxes: string[];
  }>

• Returns the parsed relay list (10002) for the pubkey

  Parameters

  • pubkey: string

  Returns Observable<undefined | {
      inboxes: string[];
      outboxes: string[];
  }>

profile

• profile(pubkey): Observable<undefined | ProfileContent>

• Returns the parsed profile (0) for a pubkey

  Parameters

  • pubkey: string

  Returns Observable<undefined | ProfileContent>

reactions

• reactions(event): Observable<Event[]>

• Returns all reactions for an event (supports replaceable events)

  Parameters

  • event: Event

  Returns Observable<Event[]>

replaceable

• replaceable(kind, pubkey, d?): Observable<undefined | Event>

• Returns the latest version of a replaceable event

  Parameters

  • kind: number
  • pubkey: string
  • Optionald: string

  Returns Observable<undefined | Event>

replaceableSet

• replaceableSet(pointers): Observable<Map<string, Event>>

• Returns a directory of events by their UID

  Parameters

  • pointers: {
        identifier?: string;
        kind: number;
        pubkey: string;
    }[]

  Returns Observable<Map<string, Event>>

runQuery

• runQuery<T, Args>(queryConstructor): ((...args: Args) => Observable<T>)

• Creates a cached query

  Type Parameters

  • T extends unknown
  • Args extends any[]

  Parameters

  • queryConstructor: ((...args: Args) => {
        key: string;
        run: ((events: EventStore, store: QueryStore) => Observable<T>);
    })
    • • (...args): {
            key: string;
            run: ((events: EventStore, store: QueryStore) => Observable<T>);
        }

      • Parameters

        • Rest...args: Args

        Returns {
            key: string;
            run: ((events: EventStore, store: QueryStore) => Observable<T>);
        }

        • key: string

        • run: ((events: EventStore, store: QueryStore) => Observable<T>)

          • • (events, store): Observable<T>

            • Parameters

              • events: EventStore
              • store: QueryStore

              Returns Observable<T>

  Returns ((...args: Args) => Observable<T>)

  • • (...args): Observable<T>

    • Parameters

      • Rest...args: Args

      Returns Observable<T>

thread

• thread(root): Observable<Thread>

• Parameters

  • root: string | EventPointer | AddressPointer

  Returns Observable<Thread>

timeline

• timeline(filters): Observable<Event[]>

• Returns an array of events that match the filter

  Parameters

  • filters: Filter | Filter[]

  Returns Observable<Event[]>