AppleSauce
    Preparing search index...

    Interface IEventStore

    The sync event store interface

    interface IEventStore {
        addressableLoader?: (
            pointer: AddressPointer,
        ) => Observable<Event> | Promise<undefined | Event>;
        eventLoader?: (
            pointer: EventPointer,
        ) => Observable<Event> | Promise<undefined | Event>;
        insert$: Observable<Event>;
        remove$: Observable<Event>;
        replaceableLoader?: (
            pointer: AddressPointerWithoutD,
        ) => Observable<Event> | Promise<undefined | Event>;
        update$: Observable<Event>;
        add(event: Event): null | Event;
        addressable(pointer: AddressPointer): Observable<undefined | Event>;
        blossomServers(user: string | ProfilePointer): Observable<URL[]>;
        claim(event: Event, claim: any): void;
        clearClaim(event: Event): void;
        comments(event: Event): Observable<Event[]>;
        contacts(user: string | ProfilePointer): Observable<ProfilePointer[]>;
        event(id: string | EventPointer): Observable<undefined | Event>;
        events(ids: string[]): Observable<Record<string, undefined | Event>>;
        filters(filters: Filter | Filter[], onlyNew?: boolean): Observable<Event>;
        getByFilters(filters: Filter | Filter[]): 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(
            user: string | ProfilePointer,
        ): Observable<undefined | { inboxes: string[]; outboxes: string[] }>;
        model<T extends unknown, Args extends any[]>(
            constructor: ModelConstructor<T, Args, IEventStore>,
            ...args: Args,
        ): Observable<T>;
        mutes(user: string | ProfilePointer): Observable<undefined | Mutes>;
        profile(
            user: string | ProfilePointer,
        ): Observable<undefined | ProfileContent>;
        reactions(event: Event): Observable<Event[]>;
        remove(event: string | Event): boolean;
        removeClaim(event: Event, claim: any): void;
        replaceable(pointer: AddressPointerWithoutD): Observable<undefined | Event>;
        replaceable(
            kind: number,
            pubkey: string,
            identifier?: string,
        ): Observable<undefined | Event>;
        replaceableSet(
            pointers: (AddressPointer | AddressPointerWithoutD)[],
        ): Observable<Record<string, undefined | Event>>;
        thread(root: string | AddressPointer | EventPointer): Observable<Thread>;
        timeline(
            filters: Filter | Filter[],
            onlyNew?: boolean,
        ): Observable<Event[]>;
        touch(event: Event): void;
        unclaimed(): Generator<Event>;
        update(event: Event): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    addressableLoader? eventLoader? insert$ remove$ replaceableLoader? update$

    Methods

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

    Properties

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

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

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

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

    insert$: Observable<Event>

    A stream of new events added to the store

    remove$: Observable<Event>

    A stream of events that have been removed

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

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

    update$: Observable<Event>

    A stream of events that have been updated

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods