Applesauce
    Preparing search index...

    Class EventStore<E>

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

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index
    constructor
    database destroy$ eventLoader? insert$ keepDeleted keepExpired keepOldVersions memory modelKeepWarm models remove$ update$
    verifyEvent
    [dispose] add addressable claim clearClaim contacts dispose event filters getByFilters getEvent getReplaceable getReplaceableHistory getSyncPairs getTimeline hasEvent hasReplaceable isClaimed mailboxes model profile prune remove removeByFilters removeClaim replaceable timeline touch unclaimed update copySymbolsToDuplicateEvent
    database: IEventDatabase<E>
    destroy$: ReplaySubject<void> = ...

    Emits when EventModels.dispose is called to tear down all models. A ReplaySubject so reset notifiers subscribed after disposal fire immediately.

    eventLoader?: (
        pointer: AddressPointer | EventPointer | AddressPointerWithoutD,
    ) => Observable<E> | Promise<E | undefined>

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

    insert$: Subject<E> = ...

    A stream of new events added to the store

    keepDeleted: boolean = false

    Keep deleted events in the store

    keepExpired: boolean = false

    Keep expired events in the store

    keepOldVersions: boolean = false

    Enable this to keep old versions of replaceable events

    memory: EventMemory<E>

    Optional memory database for ensuring single event instances

    modelKeepWarm: number = 60_000

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

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

    A directory of all active models

    remove$: Subject<E> = ...

    A stream of events that have been removed

    update$: Subject<E> = ...

    A stream of events that have been updated (Warning: this is a very noisy stream, use with caution)

    • Adds an event to the store and update subscriptions

      Parameters

      • event: E
      • OptionalfromRelay: string

      Returns E | null

      The existing event or the event that was added, if it was ignored returns null

    • Tears down the store: disposes the attached event loader, completes the event streams, releases model keep-warm timers, and unsubscribes internal manager listeners.

      Returns void

      This is a terminal operation; the store should be discarded after calling it.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods