Documentation
    Preparing search index...

    Interface StreamingOutboxRouter

    Outbox router with an incremental surface for bounded queries.

    interface StreamingOutboxRouter {
        getEvent?(
            eventId: string,
            options?: OutboxEventOptions,
        ): Promise<OutboxEventResult>;
        publish(
            template: EventTemplate,
            options?: OutboxPublishOptions,
        ): Promise<OutboxPublishResult>;
        query(
            filters: NostrFilter[],
            options?: OutboxQueryOptions,
        ): Promise<OutboxResult>;
        queryStream(
            filters: NostrFilter[],
            options: OutboxQueryOptions | undefined,
            sink: OutboxQueryStreamSink,
        ): OutboxQueryStream;
        resolveRelays(target: OutboxTarget): Promise<OutboxRelayPlan>;
        subscribe(
            filters: NostrFilter[],
            options: OutboxSubscribeOptions | undefined,
            sink: OutboxSubscriptionSink,
        ): OutboxRouterSubscription;
    }

    Hierarchy (View Summary)

    Index

    Methods

    getEvent? publish query queryStream resolveRelays subscribe

    Methods

    Settings

    Member Visibility

    On This Page

    Methods