Class Database

constructor

• new Database(): Database

• Returns Database

events

inserted

OptionalonBeforeInsert

removed

updated

size

• get size(): number

• Returns number

addEvent

• addEvent(event): Event

• Inserts an event into the database and notifies all subscriptions

  Parameters

  • event: Event

  Returns Event

claimEvent

• claimEvent(event, claim): void

• Sets the claim on the event and touches it

  Parameters

  • event: Event
  • claim: any

  Returns void

clearClaim

• clearClaim(event): void

• Removes all claims on an event

  Parameters

  • event: Event

  Returns void

getEvent

• getEvent(id): undefined | Event

• Gets a single event based on id

  Parameters

  • id: string

  Returns undefined | Event

getEventsForFilter

• getEventsForFilter(filter): Set<Event>

• Returns all events that match the filter

  Parameters

  • filter: Filter

  Returns Set<Event>

getForFilters

• getForFilters(filters): Set<Event>

• Parameters

  • filters: Filter[]

  Returns Set<Event>

getReplaceable

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

• Gets an array of replaceable events

  Parameters

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

  Returns undefined | Event[]

hasEvent

• hasEvent(id): boolean

• Checks if the database contains an event without touching it

  Parameters

  • id: string

  Returns boolean

hasReplaceable

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

• Checks if the database contains a replaceable event without touching it

  Parameters

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

  Returns boolean

isClaimed

• isClaimed(event): boolean

• Checks if an event is claimed by anything

  Parameters

  • event: Event

  Returns boolean

iterateAuthors

• iterateAuthors(authors): Generator<Event, any, any>

• Parameters

  • authors: Iterable<string, any, any>

  Returns Generator<Event, any, any>

iterateIds

• iterateIds(ids): Generator<Event, any, any>

• Parameters

  • ids: Iterable<string, any, any>

  Returns Generator<Event, any, any>

iterateKinds

• iterateKinds(kinds): Generator<Event, any, any>

• Parameters

  • kinds: Iterable<number, any, any>

  Returns Generator<Event, any, any>

iterateTag

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

• Parameters

  • tag: string
  • values: Iterable<string, any, any>

  Returns Generator<Event, any, any>

iterateTime

• iterateTime(since, until): Generator<Event, any, any>

• Parameters

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

  Returns Generator<Event, any, any>

prune

• prune(limit?): number

• Remove the oldest events that are not claimed

  Parameters

  • limit: number = 1000

  Returns number

removeClaim

• removeClaim(event, claim): void

• Removes a claim from an event

  Parameters

  • event: Event
  • claim: any

  Returns void

removeEvent

• removeEvent(eventOrId): boolean

• Removes an event from the database and notifies all subscriptions

  Parameters

  • eventOrId: string | Event

  Returns boolean

touch

• touch(event): void

• Moves an event to the top of the LRU cache

  Parameters

  • event: Event

  Returns void

updateEvent

• updateEvent(event): Event

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

  Parameters

  • event: Event

  Returns Event