Class EventStore

A wrapper around an event database that handles replaceable events, deletes, and models

Hierarchy

(Anonymous class)<typeof __class, IEventStore | IAsyncEventStore, this> & (Anonymous class)<
this,
>
- EventStore

Implements

IEventStore

Indexable

[key: string]: any

Constructors

constructor

new EventStore(database?: IEventDatabase): EventStore
Parameters
- database: IEventDatabase = ...
Returns EventStore
Overrides EventStoreModelMixin(class {}).constructor
- Defined in packages/core/src/event-store/event-store.ts:62

Properties

`Optional`addressableLoader

addressableLoader?: (
pointer: AddressPointer,
) => Observable<Event> | Promise<Event | undefined>

A method that will be called when an addressable event isn't found in the store

database

database: IEventDatabase

`Protected`deletedCoords

deletedCoords: Map<string, number> = ...

`Protected`deletedIds

deletedIds: Set<string> = ...

`Optional`eventLoader

eventLoader?: (
pointer: EventPointer,
) => Observable<Event> | Promise<Event | undefined>

A method that will be called when an event isn't found in the store

`Protected`expirations

expirations: Map<string, number> = ...

`Protected`expirationTimeout

expirationTimeout: number | null = null

insert$

insert$: Subject<Event> = ...

A stream of new events added to the store

keepExpired

keepExpired: boolean = false

Enable this to keep expired events

keepOldVersions

keepOldVersions: boolean = false

Enable this to keep old versions of replaceable events

`Optional`memory

memory?: EventMemory

Optional memory database for ensuring single event instances

modelKeepWarm

modelKeepWarm: number = 60_000

How long a model should be kept "warm" while nothing is subscribed to it

models

models: Map<
ModelConstructor<any, any[], IEventStore | IAsyncEventStore>,
Map<string, Observable<any>>,
> = ...

A directory of all active models

`Protected`nextExpirationCheck

nextExpirationCheck: number | null = null

remove$

remove$: Subject<Event> = ...

A stream of events that have been removed

`Optional`replaceableLoader

replaceableLoader?: (
pointer: AddressPointerWithoutD,
) => Observable<Event> | Promise<Event | undefined>

A method that will be called when a replaceable event isn't found in the store

update$

update$: Subject<Event> = ...

A stream of events that have been updated

`Optional`verifyEvent

verifyEvent?: (event: Event) => boolean

A method used to verify new events before added them

Type Declaration

- (event: Event): boolean
- Parameters
  - event: Event
  Returns boolean
  true if the event is valid, false if it should be ignored

Methods

add

add(event: Event, fromRelay?: string): Event | null
Adds an event to the store and update subscriptions
Parameters
- event: Event
- OptionalfromRelay: string
Returns Event | null
The existing event or the event that was added, if it was ignored returns null
Implementation of IEventStore.add
- Defined in packages/core/src/event-store/event-store.ts:195

`Protected`addExpiration

addExpiration(event: Event): void
Adds an event to the expiration map
Parameters
- event: Event
Returns void
- Defined in packages/core/src/event-store/event-store.ts:113

addressable

addressable(pointer: AddressPointer): Observable<Event | undefined>
Subscribe to an addressable event by pointer
Parameters
- pointer: AddressPointer
Returns Observable<Event | undefined>
Implementation of IEventStore.addressable
Inherited from EventStoreModelMixin(class {}).addressable
- Defined in packages/core/src/event-store/model-mixin.ts:133

blossomServers

blossomServers(user: string | ProfilePointer): Observable<URL[]>
Subscribe to a users blossom servers
Parameters
- user: string | ProfilePointer
Returns Observable<URL[]>
Implementation of IEventStore.blossomServers
Inherited from EventStoreModelMixin(class {}).blossomServers
- Defined in packages/core/src/event-store/model-mixin.ts:162

`Protected`checkDeleted

checkDeleted(event: string | Event): boolean
Parameters
- event: string | Event
Returns boolean
- Defined in packages/core/src/event-store/event-store.ts:95

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 IEventStore.claim
- Defined in packages/core/src/event-store/event-store.ts:375

clearClaim

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

comments

comments(event: Event): Observable<Event[]>
Subscribe to a event's comments
Parameters
- event: Event
Returns Observable<Event[]>
Implementation of IEventStore.comments
Inherited from EventStoreModelMixin(class {}).comments
- Defined in packages/core/src/event-store/model-mixin.ts:175

contacts

contacts(user: string | ProfilePointer): Observable<ProfilePointer[]>
Subscribe to a users contacts
Parameters
- user: string | ProfilePointer
Returns Observable<ProfilePointer[]>
Implementation of IEventStore.contacts
Inherited from EventStoreModelMixin(class {}).contacts
- Defined in packages/core/src/event-store/model-mixin.ts:147

event

event(pointer: string | EventPointer): Observable<Event | undefined>
Creates a EventModel
Parameters
- pointer: string | EventPointer
Returns Observable<Event | undefined>
Implementation of IEventStore.event
Inherited from EventStoreModelMixin(class {}).event
- Defined in packages/core/src/event-store/model-mixin.ts:108

events

events(ids: string[]): Observable<Record<string, Event | undefined>>
Parameters
- ids: string[]
Returns Observable<Record<string, Event | undefined>>
Deprecated
use multiple EventModel instead
Implementation of IEventStore.events
Inherited from EventStoreModelMixin(class {}).events
- Defined in packages/core/src/event-store/model-mixin.ts:180

filters

filters(filters: Filter | Filter[], onlyNew?: boolean): Observable<Event>
Creates an observable that streams all events that match the filter
Parameters
- filters: Filter | Filter[]
- OptionalonlyNew: boolean = false
  Only subscribe to new events
Returns Observable<Event>
Implementation of IEventStore.filters
Inherited from EventStoreModelMixin(class {}).filters
- Defined in packages/core/src/event-store/model-mixin.ts:82

getByFilters

getByFilters(filters: Filter | Filter[]): Event[]
Get all events matching a filter
Parameters
- filters: Filter | Filter[]
Returns Event[]
Implementation of IEventStore.getByFilters
- Defined in packages/core/src/event-store/event-store.ts:355

getEvent

getEvent(id: string): Event | undefined
Get an event by id from the store
Parameters
- id: string
Returns Event | undefined
Implementation of IEventStore.getEvent
- Defined in packages/core/src/event-store/event-store.ts:325

getReplaceable

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

getReplaceableHistory

getReplaceableHistory(
    kind: number,
    pubkey: string,
    identifier?: string,
): Event[] | undefined
Returns all versions of a replaceable event
Parameters
- kind: number
- pubkey: string
- Optionalidentifier: string
Returns Event[] | undefined
Implementation of IEventStore.getReplaceableHistory
- Defined in packages/core/src/event-store/event-store.ts:346

getTimeline

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

`Protected`handleDeleteEvent

handleDeleteEvent(deleteEvent: Event): void
Parameters
- deleteEvent: Event
Returns void
- Defined in packages/core/src/event-store/event-store.ts:154

`Protected`handleExpiringEvent

handleExpiringEvent(event: Event): void
Parameters
- event: Event
Returns void
- Defined in packages/core/src/event-store/event-store.ts:120

hasEvent

hasEvent(id: string): boolean
Check if the store has an event by id
Parameters
- id: string
Returns boolean
Implementation of IEventStore.hasEvent
- Defined in packages/core/src/event-store/event-store.ts:319

hasReplaceable

hasReplaceable(kind: number, pubkey: string, d?: string): boolean
Check if the store has a replaceable event
Parameters
- kind: number
- pubkey: string
- Optionald: string
Returns boolean
Implementation of IEventStore.hasReplaceable
- Defined in packages/core/src/event-store/event-store.ts:331

isClaimed

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

mailboxes

mailboxes(
user: string | ProfilePointer,
): Observable<{ inboxes: string[]; outboxes: string[] } | undefined>
Subscribe to a users NIP-65 mailboxes
Parameters
- user: string | ProfilePointer
Returns Observable<{ inboxes: string[]; outboxes: string[] } | undefined>
Implementation of IEventStore.mailboxes
Inherited from EventStoreModelMixin(class {}).mailboxes
- Defined in packages/core/src/event-store/model-mixin.ts:157

model

model<T extends unknown, Args extends any[]>(
constructor: ModelConstructor<T, Args, IEventStore | IAsyncEventStore>,
...args: Args,
): Observable<T>
Get or create a model on the event store
Type Parameters
- T extends unknown
- Args extends any[]
Parameters
- constructor: ModelConstructor<T, Args, IEventStore | IAsyncEventStore>
- ...args: Args
Returns Observable<T>
Implementation of IEventStore.model
Inherited from EventStoreModelMixin(class {}).model
- Defined in packages/core/src/event-store/model-mixin.ts:39

mutes

mutes(user: string | ProfilePointer): Observable<Mutes | undefined>
Subscribe to a users mutes
Parameters
- user: string | ProfilePointer
Returns Observable<Mutes | undefined>
Implementation of IEventStore.mutes
Inherited from EventStoreModelMixin(class {}).mutes
- Defined in packages/core/src/event-store/model-mixin.ts:152

profile

profile(user: string | ProfilePointer): Observable<ProfileContent | undefined>
Subscribe to a users profile
Parameters
- user: string | ProfilePointer
Returns Observable<ProfileContent | undefined>
Implementation of IEventStore.profile
Inherited from EventStoreModelMixin(class {}).profile
- Defined in packages/core/src/event-store/model-mixin.ts:143

prune

prune(limit?: number): number
Removes any event that is not being used by a subscription
Parameters
- Optionallimit: number
Returns number
- Defined in packages/core/src/event-store/event-store.ts:395

`Protected`pruneExpired

pruneExpired(): void
Remove expired events from the store

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

reactions

reactions(event: Event): Observable<Event[]>
Subscribe to an event's reactions
Parameters
- event: Event
Returns Observable<Event[]>
Implementation of IEventStore.reactions
Inherited from EventStoreModelMixin(class {}).reactions
- Defined in packages/core/src/event-store/model-mixin.ts:167

remove

remove(event: string | Event): boolean
Removes an event from the store and updates subscriptions
Parameters
- event: string | Event
Returns boolean
Implementation of IEventStore.remove
- Defined in packages/core/src/event-store/event-store.ts:269

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-store.ts:287

removeClaim

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

removed

removed(id: string): Observable<never>
Returns an observable that completes when an event is removed
Parameters
- id: string
Returns Observable<never>
- Defined in packages/core/src/event-store/event-store.ts:400

replaceable

replaceable(
pointer: AddressPointer | AddressPointerWithoutD,
): Observable<Event | undefined>
Creates a ReplaceableModel
Parameters
- pointer: AddressPointer | AddressPointerWithoutD
Returns Observable<Event | undefined>
Implementation of IEventStore.replaceable
Inherited from EventStoreModelMixin(class {}).replaceable
- Defined in packages/core/src/event-store/model-mixin.ts:114
replaceable(
    kind: number,
    pubkey: string,
    identifier?: string,
): Observable<Event | undefined>
Creates a ReplaceableModel
Parameters
- kind: number
- pubkey: string
- Optionalidentifier: string
Returns Observable<Event | undefined>
Implementation of IEventStore.replaceable
Inherited from EventStoreModelMixin(class {}).replaceable
- Defined in packages/core/src/event-store/model-mixin.ts:115

replaceableSet

replaceableSet(
pointers: { identifier?: string; kind: number; pubkey: string }[],
): Observable<Record<string, Event | undefined>>
Parameters
- pointers: { identifier?: string; kind: number; pubkey: string }[]
Returns Observable<Record<string, Event | undefined>>
Deprecated
use multiple ReplaceableModel instead
Implementation of IEventStore.replaceableSet
Inherited from EventStoreModelMixin(class {}).replaceableSet
- Defined in packages/core/src/event-store/model-mixin.ts:184

thread

thread(root: string | AddressPointer | EventPointer): Observable<Thread>
Subscribe to a thread
Parameters
- root: string | AddressPointer | EventPointer
Returns Observable<Thread>
Implementation of IEventStore.thread
Inherited from EventStoreModelMixin(class {}).thread
- Defined in packages/core/src/event-store/model-mixin.ts:171

timeline

timeline(
filters: Filter | Filter[],
includeOldVersion?: boolean,
): Observable<Event[]>
Creates a TimelineModel
Parameters
- filters: Filter | Filter[]
- includeOldVersion: boolean = false
Returns Observable<Event[]>
Implementation of IEventStore.timeline
Inherited from EventStoreModelMixin(class {}).timeline
- Defined in packages/core/src/event-store/model-mixin.ts:138

touch

touch(event: Event): void | undefined
Passthrough method for the database.touch
Parameters
- event: Event
Returns void | undefined
Implementation of IEventStore.touch
- Defined in packages/core/src/event-store/event-store.ts:371

unclaimed

unclaimed(): Generator<Event>
Pass through method for the database.unclaimed

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

update

update(event: Event): boolean
Add an event to the store and notifies all subscribes it has updated
Parameters
- event: Event
Returns boolean
Implementation of IEventStore.update
- Defined in packages/core/src/event-store/event-store.ts:306

updated

updated(event: string | Event): Observable<Event>
Creates an observable that emits when event is updated
Parameters
- event: string | Event
Returns Observable<Event>
- Defined in packages/core/src/event-store/event-store.ts:415

`Static`mergeDuplicateEvent

mergeDuplicateEvent(source: Event, dest: Event): void
Copies important metadata from and identical event to another
Parameters
- source: Event
- dest: Event
Returns void
- Defined in packages/core/src/event-store/event-store.ts:180

Class EventStore

Hierarchy

Implements

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EventStore

Properties

OptionaladdressableLoader

database

ProtecteddeletedCoords

ProtecteddeletedIds

OptionaleventLoader

Protectedexpirations

ProtectedexpirationTimeout

insert$

keepExpired

keepOldVersions

Optionalmemory

modelKeepWarm

models

ProtectednextExpirationCheck

remove$

OptionalreplaceableLoader

update$

OptionalverifyEvent

Type Declaration

Parameters

Returns boolean

Methods

add

Parameters

Returns Event | null

ProtectedaddExpiration

Parameters

Returns void

addressable

Parameters

Returns Observable<Event | undefined>

blossomServers

Parameters

Returns Observable<URL[]>

ProtectedcheckDeleted

Parameters

Returns boolean

claim

Parameters

Returns void

clearClaim

Parameters

Returns void

comments

Parameters

Returns Observable<Event[]>

contacts

Parameters

Returns Observable<ProfilePointer[]>

event

Parameters

Returns Observable<Event | undefined>

events

Parameters

Returns Observable<Record<string, Event | undefined>>

Deprecated

filters

Parameters

Returns Observable<Event>

getByFilters

Parameters

Returns Event[]

getEvent

Parameters

Returns Event | undefined

getReplaceable

Parameters

`Optional`addressableLoader

`Protected`deletedCoords

`Protected`deletedIds

`Optional`eventLoader

`Protected`expirations

`Protected`expirationTimeout

`Optional`memory

`Protected`nextExpirationCheck

`Optional`replaceableLoader

`Optional`verifyEvent

`Protected`addExpiration

`Protected`checkDeleted

`Protected`handleDeleteEvent

`Protected`handleExpiringEvent

`Protected`pruneExpired