AppleSauce
    Preparing search index...

    Interface IAsyncEventStore

    Generic async event store interface

    interface IAsyncEventStore {
        eventLoader?: (
            pointer: AddressPointer | EventPointer | AddressPointerWithoutD,
        ) => Promise<NostrEvent | undefined> | Observable<NostrEvent>;
        insert$: Observable<NostrEvent>;
        remove$: Observable<NostrEvent>;
        update$: Observable<NostrEvent>;
        add(event: NostrEvent): Promise<NostrEvent | null>;
        addressable(pointer: AddressPointer): Observable<NostrEvent | undefined>;
        claim(event: NostrEvent): void;
        clearClaim(event: NostrEvent): void;
        contacts(user: string | ProfilePointer): Observable<ProfilePointer[]>;
        event(
            id: string | AddressPointer | EventPointer | AddressPointerWithoutD,
        ): Observable<NostrEvent | undefined>;
        filters(
            filters: Filter | Filter[],
            onlyNew?: boolean,
        ): Observable<NostrEvent>;
        getByFilters(filters: Filter | Filter[]): Promise<NostrEvent[]>;
        getEvent(
            id: string | AddressPointer | EventPointer | AddressPointerWithoutD,
        ): Promise<NostrEvent | undefined>;
        getReplaceable(
            kind: number,
            pubkey: string,
            identifier?: string,
        ): Promise<NostrEvent | undefined>;
        getReplaceableHistory(
            kind: number,
            pubkey: string,
            identifier?: string,
        ): Promise<NostrEvent[] | undefined>;
        getTimeline(filters: Filter | Filter[]): Promise<NostrEvent[]>;
        hasEvent(
            id: string | AddressPointer | EventPointer | AddressPointerWithoutD,
        ): Promise<boolean>;
        hasReplaceable(
            kind: number,
            pubkey: string,
            identifier?: string,
        ): Promise<boolean>;
        isClaimed(event: NostrEvent): boolean;
        mailboxes(
            user: string | ProfilePointer,
        ): Observable<{ inboxes: string[]; outboxes: string[] } | undefined>;
        model<T extends unknown, Args extends any[]>(
            constructor: ModelConstructor<T, Args, IAsyncEventStore>,
            ...args: Args,
        ): Observable<T>;
        profile(
            user: string | ProfilePointer,
        ): Observable<ProfileContent | undefined>;
        remove(event: string | NostrEvent): Promise<boolean>;
        removeClaim(event: NostrEvent): void;
        replaceable(
            pointer: AddressPointerWithoutD,
        ): Observable<NostrEvent | undefined>;
        replaceable(
            kind: number,
            pubkey: string,
            identifier?: string,
        ): Observable<NostrEvent | undefined>;
        timeline(
            filters: Filter | Filter[],
            onlyNew?: boolean,
        ): Observable<NostrEvent[]>;
        touch(event: NostrEvent): void;
        unclaimed(): Generator<NostrEvent>;
        update(event: NostrEvent): Promise<void>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    eventLoader? insert$ remove$ update$

    Methods

    add addressable claim clearClaim contacts event filters getByFilters getEvent getReplaceable getReplaceableHistory getTimeline hasEvent hasReplaceable isClaimed mailboxes model profile remove removeClaim replaceable timeline touch unclaimed update

    Properties

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

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

    insert$: Observable<NostrEvent>

    A stream of new events added to the store

    remove$: Observable<NostrEvent>

    A stream of events that have been removed

    update$: Observable<NostrEvent>

    A stream of events that have been updated

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods