Class Database

An in-memory database for nostr events NOTE: does not handle replaceable events

Constructors

constructor

new Database(): Database
Returns Database

Properties

`Protected`authors

authors: Map<string, Set<Event>> = ...

`Protected`claims

claims: WeakMap<Event, any> = ...

`Protected`created_at

created_at: Event[] = []

deleted

deleted: Subject<Event> = ...

A stream of events removed of the database

events

events: LRU<Event> = ...

LRU cache of last events touched

inserted

inserted: Subject<Event> = ...

A stream of events inserted into the database

`Protected`kinds

kinds: Map<number, Set<Event>> = ...

Indexes

`Protected`log

log: Debugger = ...

`Protected`replaceable

replaceable: Map<string, Event[]> = ...

`Protected`tags

tags: LRU<Set<Event>> = ...

updated

updated: Subject<Event> = ...

A stream of events that have been updated

Accessors

size

get size(): number
Returns number
- Defined in packages/core/src/event-store/database.ts:36

Methods

addEvent

addEvent(event): Event
Inserts an event into the database and notifies all subscriptions
Parameters
- event: Event
Returns Event
- Defined in packages/core/src/event-store/database.ts:95

claimEvent

claimEvent(event, claim): void
Sets the claim on the event and touches it
Parameters
- event: Event
- claim: any
Returns void
- Defined in packages/core/src/event-store/database.ts:185

clearClaim

clearClaim(event): void
Removes all claims on an event
Parameters
- event: Event
Returns void
- Defined in packages/core/src/event-store/database.ts:203

deleteEvent

deleteEvent(eventOrId): boolean
Deletes an event from the database and notifies all subscriptions
Parameters
- eventOrId: string | Event
Returns boolean
- Defined in packages/core/src/event-store/database.ts:145

`Protected`getAuthorsIndex

getAuthorsIndex(author): Set<Event>
Parameters
- author: string
Returns Set<Event>
- Defined in packages/core/src/event-store/database.ts:47

getEvent

getEvent(id): undefined | Event
Gets a single event based on id
Parameters
- id: string
Returns undefined | Event
- Defined in packages/core/src/event-store/database.ts:80

getEventsForFilter

getEventsForFilter(filter): Set<Event>
Returns all events that match the filter
Parameters
- filter: Filter
Returns Set<Event>
- Defined in packages/core/src/event-store/database.ts:269

getForFilters

getForFilters(filters): Set<Event>
Parameters
- filters: Filter[]
Returns Set<Event>
- Defined in packages/core/src/event-store/database.ts:326

`Protected`getKindIndex

getKindIndex(kind): Set<Event>
Index helper methods
Parameters
- kind: number
Returns Set<Event>
- Defined in packages/core/src/event-store/database.ts:43

getReplaceable

getReplaceable(kind, pubkey, d?): undefined | Event[]
Gets an array of replaceable events
Parameters
- kind: number
- pubkey: string
- Optionald: string
Returns undefined | Event[]
- Defined in packages/core/src/event-store/database.ts:90

`Protected`getTagIndex

getTagIndex(tagAndValue): Set<Event>
Parameters
- tagAndValue: string
Returns Set<Event>
- Defined in packages/core/src/event-store/database.ts:51

hasEvent

hasEvent(id): boolean
Checks if the database contains an event without touching it
Parameters
- id: string
Returns boolean
- Defined in packages/core/src/event-store/database.ts:76

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
- Defined in packages/core/src/event-store/database.ts:85

isClaimed

isClaimed(event): boolean
Checks if an event is claimed by anything
Parameters
- event: Event
Returns boolean
- Defined in packages/core/src/event-store/database.ts:194

iterateAuthors

iterateAuthors(authors): Generator<Event, any, any>
Parameters
- authors: Iterable<string, any, any>
Returns Generator<Event, any, any>
- Defined in packages/core/src/event-store/database.ts:207

iterateIds

iterateIds(ids): Generator<Event, any, any>
Parameters
- ids: Iterable<string, any, any>
Returns Generator<Event, any, any>
- Defined in packages/core/src/event-store/database.ts:262

iterateKinds

iterateKinds(kinds): Generator<Event, any, any>
Parameters
- kinds: Iterable<number, any, any>
Returns Generator<Event, any, any>
- Defined in packages/core/src/event-store/database.ts:227

iterateTag

iterateTag(tag, values): Generator<Event, any, any>
Parameters
- tag: string
- values: Iterable<string, any, any>
Returns Generator<Event, any, any>
- Defined in packages/core/src/event-store/database.ts:217

iterateTime

iterateTime(since, until): Generator<Event, any, any>
Parameters
- since: undefined | number
- until: undefined | number
Returns Generator<Event, any, any>
- Defined in packages/core/src/event-store/database.ts:237

prune

prune(limit?): number
Remove the oldest events that are not claimed
Parameters
- limit: number = 1000
Returns number
- Defined in packages/core/src/event-store/database.ts:340

removeClaim

removeClaim(event, claim): void
Removes a claim from an event
Parameters
- event: Event
- claim: any
Returns void
- Defined in packages/core/src/event-store/database.ts:198

touch

touch(event): void
Moves an event to the top of the LRU cache
Parameters
- event: Event
Returns void
- Defined in packages/core/src/event-store/database.ts:71

updateEvent

updateEvent(event): Event
Inserts and event into the database and notifies all subscriptions that the event has updated
Parameters
- event: Event
Returns Event
- Defined in packages/core/src/event-store/database.ts:138

Class Database

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Database

Properties

Protectedauthors

Protectedclaims

Protectedcreated_at

deleted

events

inserted

Protectedkinds

Protectedlog

Protectedreplaceable

Protectedtags

updated

Accessors

size

Returns number

Methods

addEvent

Parameters

Returns Event

claimEvent

Parameters

Returns void

clearClaim

Parameters

Returns void

deleteEvent

Parameters

Returns boolean

ProtectedgetAuthorsIndex

Parameters

Returns Set<Event>

getEvent

Parameters

Returns undefined | Event

getEventsForFilter

Parameters

Returns Set<Event>

getForFilters

Parameters

Returns Set<Event>

ProtectedgetKindIndex

Parameters

Returns Set<Event>

getReplaceable

Parameters

Returns undefined | Event[]

ProtectedgetTagIndex

Parameters

Returns Set<Event>

hasEvent

Parameters

Returns boolean

hasReplaceable

Parameters

Returns boolean

isClaimed

Parameters

Returns boolean

iterateAuthors

Parameters

Returns Generator<Event, any, any>

iterateIds

Parameters

Returns Generator<Event, any, any>

iterateKinds

Parameters

Returns Generator<Event, any, any>

iterateTag

Parameters

Returns Generator<Event, any, any>

iterateTime

`Protected`authors

`Protected`claims

`Protected`created_at

`Protected`kinds

`Protected`log

`Protected`replaceable

`Protected`tags

`Protected`getAuthorsIndex

`Protected`getKindIndex

`Protected`getTagIndex