Class Database

constructor

• new Database(): Database

• Returns Database

deleted

events

inserted

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

deleteEvent

• deleteEvent(eventOrUID): boolean

• Deletes an event from the database and notifies all subscriptions

  Parameters

  • eventOrUID: string | Event

  Returns boolean

getEvent

• getEvent(uid): undefined | Event

• Parameters

  • uid: 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 a replaceable event and touches it

  Parameters

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

  Returns undefined | Event

hasEvent

• hasEvent(uid): undefined | Event

• Parameters

  • uid: string

  Returns undefined | Event

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, void, unknown>

• Parameters

  • authors: Iterable<string>

  Returns Generator<Event, void, unknown>

iterateIds

• iterateIds(ids): Generator<Event, void, unknown>

• Parameters

  • ids: Iterable<string>

  Returns Generator<Event, void, unknown>

iterateKinds

• iterateKinds(kinds): Generator<Event, void, unknown>

• Parameters

  • kinds: Iterable<number>

  Returns Generator<Event, void, unknown>

iterateTag

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

• Parameters

  • tag: string
  • values: Iterable<string>

  Returns Generator<Event, void, unknown>

iterateTime

• iterateTime(since, until): Generator<never, Set<Event>, unknown>

• Parameters

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

  Returns Generator<never, Set<Event>, unknown>

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

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