Class Database

constructor

• new Database(): Database

  Returns Database

events

inserted

OptionalonBeforeInsert

removed

updated

size

• get size(): number

  Returns number

addEvent

• addEvent(event: Event): Event

  Inserts an event into the database and notifies all subscriptions

  Parameters

  • event: Event

  Returns Event

claimEvent

• claimEvent(event: Event, claim: any): void

  Sets the claim on the event and touches it

  Parameters

  • event: Event
  • claim: any

  Returns void

clearClaim

• clearClaim(event: Event): void

  Removes all claims on an event

  Parameters

  • event: Event

  Returns void

getEvent

• getEvent(id: string): undefined | Event

  Gets a single event based on id

  Parameters

  • id: string

  Returns undefined | Event

getEventsForFilter

• getEventsForFilter(filter: Filter): Set<Event>

  Returns all events that match the filter

  Parameters

  • filter: Filter

  Returns Set<Event>

getEventsForFilters

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

  Parameters

  • filters: Filter[]

  Returns Set<Event>

getReplaceable

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

  Gets an array of replaceable events

  Parameters

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

  Returns undefined | Event[]

hasEvent

• hasEvent(id: string): boolean

  Checks if the database contains an event without touching it

  Parameters

  • id: string

  Returns boolean

hasReplaceable

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

  Checks if the database contains a replaceable event without touching it

  Parameters

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

  Returns boolean

isClaimed

• isClaimed(event: Event): boolean

  Checks if an event is claimed by anything

  Parameters

  • event: Event

  Returns boolean

iterateAuthors

• iterateAuthors(authors: Iterable<string>): Generator<Event>

  Parameters

  • authors: Iterable<string>

  Returns Generator<Event>

iterateIds

• iterateIds(ids: Iterable<string>): Generator<Event>

  Parameters

  • ids: Iterable<string>

  Returns Generator<Event>

iterateKinds

• iterateKinds(kinds: Iterable<number>): Generator<Event>

  Parameters

  • kinds: Iterable<number>

  Returns Generator<Event>

iterateTag

• iterateTag(tag: string, values: Iterable<string>): Generator<Event>

  Parameters

  • tag: string
  • values: Iterable<string>

  Returns Generator<Event>

iterateTime

• iterateTime(
      since: undefined | number,
      until: undefined | number,
  ): Generator<Event>

  Parameters

  • since: undefined | number
  • until: undefined | number

  Returns Generator<Event>

prune

• prune(limit?: number): number

  Remove the oldest events that are not claimed

  Parameters

  • limit: number = 1000

  Returns number

removeClaim

• removeClaim(event: Event, claim: any): void

  Removes a claim from an event

  Parameters

  • event: Event
  • claim: any

  Returns void

removeEvent

• removeEvent(eventOrId: string | Event): boolean

  Removes an event from the database and notifies all subscriptions

  Parameters

  • eventOrId: string | Event

  Returns boolean

touch

• touch(event: Event): void

  Moves an event to the top of the LRU cache

  Parameters

  • event: Event

  Returns void

updateEvent

• updateEvent(event: Event): Event

  Inserts and event into the database and notifies all subscriptions that the event has updated

  Parameters

  • event: Event

  Returns Event