Class EventStore

The read interface for an event store

Implements

IEventStore

Constructors

constructor

new EventStore(): EventStore
Returns EventStore
- Defined in packages/core/src/event-store/event-store.ts:47

Properties

database

database: EventSet

`Protected`deletedCoords

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

`Protected`deletedIds

deletedIds: Set<string> = ...

insert$

insert$: Observable<Event>

A stream of new events added to the store

keepOldVersions

keepOldVersions: boolean = false

Enable this to keep old versions of replaceable events

modelKeepWarm

modelKeepWarm: number = 60_000

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

`Protected`models

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

A directory of all active models

remove$

remove$: Observable<Event>

A stream of events that have been removed

update$

update$: Observable<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): null | Event
Adds an event to the store and update subscriptions
Parameters
- event: Event
- OptionalfromRelay: string
Returns null | Event
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:132

blossomServers

blossomServers(pubkey: string): Observable<URL[]>
Creates a UserBlossomServersModel
Parameters
- pubkey: string
Returns Observable<URL[]>
Implementation of IEventStore.blossomServers
- Defined in packages/core/src/event-store/event-store.ts:391

`Protected`checkDeleted

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

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:239

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:251

comments

comments(event: Event): Observable<Event[]>
Creates a CommentsModel
Parameters
- event: Event
Returns Observable<Event[]>
- Defined in packages/core/src/event-store/event-store.ts:401

contacts

contacts(pubkey: string): Observable<ProfilePointer[]>
Creates a ContactsModel
Parameters
- pubkey: string
Returns Observable<ProfilePointer[]>
Implementation of IEventStore.contacts
- Defined in packages/core/src/event-store/event-store.ts:371

event

event(id: string): Observable<undefined | Event>
Creates a EventModel
Parameters
- id: string
Returns Observable<undefined | Event>
Implementation of IEventStore.event
- Defined in packages/core/src/event-store/event-store.ts:339

events

events(ids: string[]): Observable<Record<string, Event>>
Creates a EventsModel
Parameters
- ids: string[]
Returns Observable<Record<string, Event>>
Implementation of IEventStore.events
- Defined in packages/core/src/event-store/event-store.ts:354

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

getByFilters

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

getEvent

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

getReplaceable

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

getReplaceableHistory

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

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:234

`Protected`handleDeleteEvent

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

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:204

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:214

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:243

mailboxes

mailboxes(
pubkey: string,
): Observable<undefined | { inboxes: string[]; outboxes: string[] }>
Creates a MailboxesModel
Parameters
- pubkey: string
Returns Observable<undefined | { inboxes: string[]; outboxes: string[] }>
Implementation of IEventStore.mailboxes
- Defined in packages/core/src/event-store/event-store.ts:386

model

model<T extends unknown, Args extends any[]>(
constructor: ModelConstructor<T, Args>,
...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>
- ...args: Args
Returns Observable<T>
Implementation of IEventStore.model
- Defined in packages/core/src/event-store/event-store.ts:262

mutes

mutes(pubkey: string): Observable<undefined | Mutes>
Creates a MuteModel
Parameters
- pubkey: string
Returns Observable<undefined | Mutes>
Implementation of IEventStore.mutes
- Defined in packages/core/src/event-store/event-store.ts:376

profile

profile(pubkey: string): Observable<undefined | ProfileContent>
Creates a ProfileModel
Parameters
- pubkey: string
Returns Observable<undefined | ProfileContent>
Implementation of IEventStore.profile
- Defined in packages/core/src/event-store/event-store.ts:366

prune

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

reactions

reactions(event: Event): Observable<Event[]>
Creates a ReactionsModel
Parameters
- event: Event
Returns Observable<Event[]>
Implementation of IEventStore.reactions
- Defined in packages/core/src/event-store/event-store.ts:381

remove

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

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:247

removed

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

replaceable

replaceable(
    kind: number,
    pubkey: string,
    identifier?: string,
): Observable<undefined | Event>
Creates a ReplaceableModel
Parameters
- kind: number
- pubkey: string
- Optionalidentifier: string
Returns Observable<undefined | Event>
Implementation of IEventStore.replaceable
- Defined in packages/core/src/event-store/event-store.ts:344

replaceableSet

replaceableSet(
pointers: { identifier?: string; kind: number; pubkey: string }[],
): Observable<Record<string, Event>>
Creates a ReplaceableSetModel
Parameters
- pointers: { identifier?: string; kind: number; pubkey: string }[]
Returns Observable<Record<string, Event>>
Implementation of IEventStore.replaceableSet
- Defined in packages/core/src/event-store/event-store.ts:359

thread

thread(root: string | EventPointer | AddressPointer): Observable<Thread>
Creates a ThreadModel
Parameters
- root: string | EventPointer | AddressPointer
Returns Observable<Thread>
Implementation of IEventStore.thread
- Defined in packages/core/src/event-store/event-store.ts:396

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

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:194

updated

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

`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:117

Class EventStore

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns EventStore

Properties

database

ProtecteddeletedCoords

ProtecteddeletedIds

insert$

keepOldVersions

modelKeepWarm

Protectedmodels

remove$

update$

OptionalverifyEvent

Type declaration

Parameters

Returns boolean

Methods

add

Parameters

Returns null | Event

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<undefined | Event>

events

Parameters

Returns Observable<Record<string, Event>>

filters

Parameters

Returns Observable<Event>

getByFilters

Parameters

Returns Set<Event>

getEvent

Parameters

Returns undefined | Event

getReplaceable

Parameters

Returns undefined | Event

getReplaceableHistory

Parameters

Returns undefined | Event[]

getTimeline

Parameters

Returns Event[]

ProtectedhandleDeleteEvent

Parameters

Returns void

hasEvent

Parameters

Returns boolean

hasReplaceable

Parameters

Returns boolean

isClaimed

Parameters

`Protected`deletedCoords

`Protected`deletedIds

`Protected`models

`Optional`verifyEvent

`Protected`checkDeleted

`Protected`handleDeleteEvent

`Static`mergeDuplicateEvent