Applesauce
    Preparing search index...

    Type Alias RelayOptions

    type RelayOptions = {
        countTimeout?: number;
        enablePing?: boolean;
        eventTimeout?: number;
        informationCache?: RelayInformationCache;
        informationCacheMs?: number;
        keepAlive?: number;
        noticeLimit?: number;
        onUnresponsive?: (
            info: {
                attempts: number;
                lastMessageAt: number;
                now: number;
                url: string;
            },
        ) => "reconnect"
        | "close"
        | "ignore";
        pingFrequency?: number;
        pingTimeout?: number;
        publishRetry?: RetryConfig;
        publishTimeout?: number;
        requestReconnect?: number | RetryConfig;
        subscriptionReconnect?: number | RetryConfig;
        WebSocket?: WebSocketSubjectConfig<any>["WebSocketCtor"];
    }
    Index
    countTimeout? enablePing? eventTimeout? informationCache? informationCacheMs? keepAlive? noticeLimit? onUnresponsive? pingFrequency? pingTimeout? publishRetry? publishTimeout? requestReconnect? subscriptionReconnect? WebSocket?
    countTimeout?: number

    Whole logical COUNT request timeout (default 10s)

    enablePing?: boolean

    Enable/disable ping functionality (default false)

    eventTimeout?: number

    How long to wait for an OK message from the relay (default 10s)

    informationCache?: RelayInformationCache

    Optional Keyv-compatible cache for NIP-11 information documents

    informationCacheMs?: number

    Lifetime of cached NIP-11 documents in milliseconds (default: 24 hours)

    keepAlive?: number

    How long to keep the connection alive after nothing is subscribed (default 30s)

    noticeLimit?: number

    Maximum retained notices as a finite non-negative integer (default 100, 0 disables history)

    onUnresponsive?: (
        info: {
            attempts: number;
            lastMessageAt: number;
            now: number;
            url: string;
        },
    ) => "reconnect"
    | "close"
    | "ignore"

    Policy for handling unresponsive connections (default: reconnect)

    pingFrequency?: number

    How often to send pings in milliseconds (default 29000)

    pingTimeout?: number

    How long to wait for EOSE response in milliseconds (default 20000)

    publishRetry?: RetryConfig

    Default retry config for publish() method

    publishTimeout?: number

    How long to wait for a publish to complete (default 30s)

    requestReconnect?: number | RetryConfig

    Default retry count or config for request() connection errors (default: 3)

    subscriptionReconnect?: number | RetryConfig

    Default retry count or config for subscription() connection errors (default: 3)

    WebSocket?: WebSocketSubjectConfig<any>["WebSocketCtor"]

    Custom WebSocket implementation

    Settings
    Member Visibility

    On This Page
    Properties