AppleSauce
    Preparing search index...

    Interface IEventStore

    The read interface for an event store

    interface IEventStore {
        insert$: Observable<Event>;
        remove$: Observable<Event>;
        update$: Observable<Event>;
        add(event: Event): null | Event;
        blossomServers(pubkey: string): Observable<URL[]>;
        claim(event: Event, claim: any): void;
        clearClaim(event: Event): void;
        contacts(pubkey: string): Observable<ProfilePointer[]>;
        event(id: string): Observable<undefined | Event>;
        events(ids: string[]): Observable<Record<string, Event>>;
        filters(filters: Filter | Filter[]): Observable<Event>;
        getByFilters(filters: Filter | Filter[]): Set<Event>;
        getEvent(id: string): undefined | Event;
        getReplaceable(
            kind: number,
            pubkey: string,
            identifier?: string,
        ): undefined | Event;
        getReplaceableHistory(
            kind: number,
            pubkey: string,
            identifier?: string,
        ): undefined | Event[];
        getTimeline(filters: Filter | Filter[]): Event[];
        hasEvent(id: string): boolean;
        hasReplaceable(kind: number, pubkey: string, identifier?: string): boolean;
        isClaimed(event: Event): boolean;
        mailboxes(
            pubkey: string,
        ): Observable<undefined | { inboxes: string[]; outboxes: string[] }>;
        model<T extends unknown, Args extends any[]>(
            constructor: ModelConstructor<T, Args>,
            ...args: Args,
        ): Observable<T>;
        mutes(pubkey: string): Observable<undefined | Mutes>;
        profile(pubkey: string): Observable<undefined | ProfileContent>;
        reactions(event: Event): Observable<Event[]>;
        remove(event: string | Event): boolean;
        removeClaim(event: Event, claim: any): void;
        removed(id: string): Observable<never>;
        replaceable(
            kind: number,
            pubkey: string,
            identifier?: string,
        ): Observable<undefined | Event>;
        replaceableSet(
            pointers: { identifier?: string; kind: number; pubkey: string }[],
        ): Observable<Record<string, Event>>;
        thread(root: string | EventPointer | AddressPointer): Observable<Thread>;
        timeline(
            filters: Filter | Filter[],
            includeOldVersion?: boolean,
        ): Observable<Event[]>;
        update(event: Event): void;
        updated(id: string | Event): Observable<Event>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    insert$ remove$ update$

    Methods

    add blossomServers claim clearClaim contacts event events filters getByFilters getEvent getReplaceable getReplaceableHistory getTimeline hasEvent hasReplaceable isClaimed mailboxes model mutes profile reactions remove removeClaim removed replaceable replaceableSet thread timeline update updated

    Properties

    insert$: Observable<Event>

    A stream of new events added to the store

    remove$: Observable<Event>

    A stream of events that have been removed

    update$: Observable<Event>

    A stream of events that have been updated

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods