Documentation
    Preparing search index...

    Interface OutboxSubscribeOptions

    Options for a live outbox subscription.

    interface OutboxSubscribeOptions {
        authors?: string[];
        limit?: number;
        live?: boolean;
        relays?: string[];
        strategy?: OutboxStrategy;
        timeoutMs?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authors? limit? live? relays? strategy? timeoutMs?

    Properties

    authors?: string[]

    Explicit author hints (augment/override authors derived from filters).

    limit?: number

    Maximum events to collect.

    live?: boolean

    Keep the subscription open for real-time events after EOSE.

    relays?: string[]

    Relay hints; treated as a hint subject to shell validation, not a bypass.

    strategy?: OutboxStrategy

    Relay-selection strategy.

    timeoutMs?: number

    Wall-clock budget for the query, in milliseconds.

    Settings

    Member Visibility

    On This Page

    Properties