Class EventStore

constructor

• new EventStore(): EventStore

  Returns EventStore

database

inserts

keepOldVersions

removes

updates

OptionalverifyEvent

add

• add(event: Event, fromRelay?: string): Event

  Adds an event to the database and update subscriptions

  Parameters

  • event: Event
  • OptionalfromRelay: string

  Returns Event

  Throws

event

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

  Creates an observable that subscribes to a single event

  Parameters

  • id: string

  Returns Observable<undefined | Event>

events

• events(ids: string[]): Observable<Record<string, Event>>

  Creates an observable that subscribes to multiple events

  Parameters

  • ids: string[]

  Returns Observable<Record<string, Event>>

filters

• filters(filters: Filter | Filter[], onlyNew?: boolean): Observable<Event>

  Creates an observable that streams all events that match the filter and remains open

  Parameters

  • filters: Filter | Filter[]
  • OptionalonlyNew: boolean = false

    Only subscribe to new events

  Returns Observable<Event>

getAll

• getAll(filters: Filter | Filter[]): Set<Event>

  Get all events matching a filter

  Parameters

  • filters: Filter | Filter[]

  Returns Set<Event>

getEvent

• getEvent(id: string): undefined | Event

  Parameters

  • id: string

  Returns undefined | Event

getReplaceable

• getReplaceable(kind: number, pubkey: string, d?: string): undefined | Event

  Gets the latest version of a replaceable event

  Parameters

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

  Returns undefined | Event

getReplaceableHistory

• getReplaceableHistory(
      kind: number,
      pubkey: string,
      d?: string,
  ): undefined | Event[]

  Returns all versions of a replaceable event

  Parameters

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

  Returns undefined | Event[]

getTimeline

• getTimeline(filters: Filter | Filter[]): Event[]

  Returns a timeline of events that match filters

  Parameters

  • filters: Filter | Filter[]

  Returns Event[]

hasEvent

• hasEvent(id: string): boolean

  Check if the store has an event

  Parameters

  • id: string

  Returns boolean

hasReplaceable

• hasReplaceable(kind: number, pubkey: string, d?: string): boolean

  Check if the store has a replaceable event

  Parameters

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

  Returns boolean

prune

• prune(max?: number): number

  Removes any event that is not being used by a subscription

  Parameters

  • Optionalmax: number

  Returns number

remove

• remove(event: string | Event): boolean

  Removes an event from the database and updates subscriptions

  Parameters

  • event: string | Event

  Returns boolean

removed

• removed(id: string): Observable<never>

  Returns an observable that completes when an event is removed

  Parameters

  • id: string

  Returns Observable<never>

replaceable

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

  Creates an observable that subscribes to the latest version of a replaceable event

  Parameters

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

  Returns Observable<undefined | Event>

replaceableSet

• replaceableSet(
      pointers: { identifier?: string; kind: number; pubkey: string }[],
  ): Observable<Record<string, Event>>

  Creates an observable that subscribes to the latest version of an array of replaceable events

  Parameters

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

  Returns Observable<Record<string, Event>>

timeline

• timeline(
      filters: Filter | Filter[],
      keepOldVersions?: boolean,
  ): Observable<Event[]>

  Creates an observable that updates with an array of sorted events

  Parameters

  • filters: Filter | Filter[]
  • keepOldVersions: boolean = false

  Returns Observable<Event[]>

update

• update(event: Event): Event

  Add an event to the store and notifies all subscribes it has updated

  Parameters

  • event: Event

  Returns Event

updated

• updated(event: string | Event): Observable<Event>

  Creates an observable that emits when event is updated

  Parameters

  • event: string | Event

  Returns Observable<Event>

StaticmergeDuplicateEvent

• mergeDuplicateEvent(source: Event, dest: Event): void

  Copies important metadata from and identical event to another

  Parameters

  • source: Event
  • dest: Event

  Returns void