Class EventMemory

An in-memory database of events

Implements

IEventMemory

Constructors

constructor

new EventMemory(): EventMemory
Returns EventMemory

Properties

`Protected`authors

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

`Protected`claims

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

A weak map of events that are claimed by other things

`Protected`created_at

created_at: Event[] = []

events

events: LRU<Event> = ...

LRU cache of last events touched

`Protected`kinds

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

Indexes

`Protected`log

log: Debugger = ...

`Protected`replaceable

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

A sorted array of replaceable events by address

`Protected`tags

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

Accessors

size

get size(): number
The number of events in the event set

Returns number
- Defined in packages/core/src/event-store/event-memory.ts:27

Methods

add

add(event: Event): Event
Inserts an event into the database and notifies all subscriptions
Parameters
- event: Event
Returns Event
Implementation of IEventMemory.add
- Defined in packages/core/src/event-store/event-memory.ts:70

claim

claim(event: Event, claim: any): void
Sets the claim on the event and touches it
Parameters
- event: Event
- claim: any
Returns void
Implementation of IEventMemory.claim
- Defined in packages/core/src/event-store/event-memory.ts:179

clearClaim

clearClaim(event: Event): void
Removes all claims on an event
Parameters
- event: Event
Returns void
Implementation of IEventMemory.clearClaim
- Defined in packages/core/src/event-store/event-memory.ts:197

`Protected`getAuthorsIndex

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

getByFilters

getByFilters(filters: Filter | Filter[]): Event[]
Gets all events that match the filters
Parameters
- filters: Filter | Filter[]
Returns Event[]
Implementation of IEventMemory.getByFilters
- Defined in packages/core/src/event-store/event-memory.ts:58

getEvent

getEvent(id: string): Event | undefined
Gets a single event based on id
Parameters
- id: string
Returns Event | undefined
Implementation of IEventMemory.getEvent
- Defined in packages/core/src/event-store/event-memory.ts:36

`Protected`getEventsForFilter

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

`Protected`getEventsForFilters

getEventsForFilters(filters: Filter[]): Set<Event>
Returns all events that match the filters
Parameters
- filters: Filter[]
Returns Set<Event>
- Defined in packages/core/src/event-store/event-memory.ts:381

`Protected`getKindIndex

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

getReplaceable

getReplaceable(
    kind: number,
    pubkey: string,
    identifier?: string,
): Event | undefined
Gets the latest replaceable event
Parameters
- kind: number
- pubkey: string
- Optionalidentifier: string
Returns Event | undefined
Implementation of IEventMemory.getReplaceable
- Defined in packages/core/src/event-store/event-memory.ts:46

getReplaceableHistory

getReplaceableHistory(
    kind: number,
    pubkey: string,
    identifier?: string,
): Event[] | undefined
Gets the history of a replaceable event
Parameters
- kind: number
- pubkey: string
- Optionalidentifier: string
Returns Event[] | undefined
Implementation of IEventMemory.getReplaceableHistory
- Defined in packages/core/src/event-store/event-memory.ts:52

`Protected`getTagIndex

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

getTimeline

getTimeline(filters: Filter | Filter[]): Event[]
Gets a timeline of events that match the filters
Parameters
- filters: Filter | Filter[]
Returns Event[]
Implementation of IEventMemory.getTimeline
- Defined in packages/core/src/event-store/event-memory.ts:62

hasEvent

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

hasReplaceable

hasReplaceable(kind: number, pubkey: string, identifier?: string): boolean
Checks if the event set has a replaceable event
Parameters
- kind: number
- pubkey: string
- Optionalidentifier: string
Returns boolean
Implementation of IEventMemory.hasReplaceable
- Defined in packages/core/src/event-store/event-memory.ts:41

isClaimed

isClaimed(event: Event): boolean
Checks if an event is claimed by anything
Parameters
- event: Event
Returns boolean
Implementation of IEventMemory.isClaimed
- Defined in packages/core/src/event-store/event-memory.ts:188

iterateAuthors

iterateAuthors(authors: Iterable<string>): Generator<Event>
Iterates over all events by author
Parameters
- authors: Iterable<string>
Returns Generator<Event>
- Defined in packages/core/src/event-store/event-memory.ts:257

iterateIds

iterateIds(ids: Iterable<string>): Generator<Event>
Iterates over all events by id
Parameters
- ids: Iterable<string>
Returns Generator<Event>
- Defined in packages/core/src/event-store/event-memory.ts:316

iterateKinds

iterateKinds(kinds: Iterable<number>): Generator<Event>
Iterates over all events by kind
Parameters
- kinds: Iterable<number>
Returns Generator<Event>
- Defined in packages/core/src/event-store/event-memory.ts:279

iterateTag

iterateTag(tag: string, values: Iterable<string>): Generator<Event>
Iterates over all events by indexable tag and value
Parameters
- tag: string
- values: Iterable<string>
Returns Generator<Event>
- Defined in packages/core/src/event-store/event-memory.ts:268

iterateTime

iterateTime(
since: number | undefined,
until: number | undefined,
): Generator<Event>
Iterates over all events by time
Parameters
- since: number | undefined
- until: number | undefined
Returns Generator<Event>
- Defined in packages/core/src/event-store/event-memory.ts:290

prune

prune(limit?: number): number
Removes events that are not claimed (free up memory)
Parameters
- Optionallimit: number
Returns number
- Defined in packages/core/src/event-store/event-memory.ts:214

remove

remove(eventOrId: string | Event): boolean
Removes an event from the database and notifies all subscriptions
Parameters
- eventOrId: string | Event
Returns boolean
Implementation of IEventMemory.remove
- Defined in packages/core/src/event-store/event-memory.ts:107

removeByFilters

removeByFilters(filters: Filter | Filter[]): number
Remove multiple events that match the given filters
Parameters
- filters: Filter | Filter[]
Returns number
- Defined in packages/core/src/event-store/event-memory.ts:149

removeClaim

removeClaim(event: Event, claim: any): void
Removes a claim from an event
Parameters
- event: Event
- claim: any
Returns void
Implementation of IEventMemory.removeClaim
- Defined in packages/core/src/event-store/event-memory.ts:192

reset

reset(): void
Resets the event set

Returns void
- Defined in packages/core/src/event-store/event-memory.ts:395

touch

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

unclaimed

unclaimed(): Generator<Event>
Returns a generator of unclaimed events in order of least used

Returns Generator<Event>
Implementation of IEventMemory.unclaimed
- Defined in packages/core/src/event-store/event-memory.ts:201

update

update(_event: Event): void
Notify the database that an event has updated
Parameters
- _event: Event
Returns void
- Defined in packages/core/src/event-store/event-memory.ts:162

Class EventMemory

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns EventMemory

Properties

Protectedauthors

Protectedclaims

Protectedcreated_at

events

Protectedkinds

Protectedlog

Protectedreplaceable

Protectedtags

Accessors

size

Returns number

Methods

add

Parameters

Returns Event

claim

Parameters

Returns void

clearClaim

Parameters

Returns void

ProtectedgetAuthorsIndex

Parameters

Returns Set<Event>

getByFilters

Parameters

Returns Event[]

getEvent

Parameters

Returns Event | undefined

ProtectedgetEventsForFilter

Parameters

Returns Set<Event>

ProtectedgetEventsForFilters

Parameters

Returns Set<Event>

ProtectedgetKindIndex

Parameters

Returns Set<Event>

getReplaceable

Parameters

Returns Event | undefined

getReplaceableHistory

Parameters

Returns Event[] | undefined

ProtectedgetTagIndex

Parameters

Returns Set<Event>

getTimeline

Parameters

Returns Event[]

hasEvent

Parameters

Returns boolean

hasReplaceable

Parameters

Returns boolean

isClaimed

Parameters

Returns boolean

iterateAuthors

Parameters

Returns Generator<Event>

iterateIds

Parameters

Returns Generator<Event>

iterateKinds

Parameters

Returns Generator<Event>

`Protected`authors

`Protected`claims

`Protected`created_at

`Protected`kinds

`Protected`log

`Protected`replaceable

`Protected`tags

`Protected`getAuthorsIndex

`Protected`getEventsForFilter

`Protected`getEventsForFilters

`Protected`getKindIndex

`Protected`getTagIndex