Applesauce
    Preparing search index...

    Type Alias RelayReqOptions

    Base options for REQ subscriptions to a relay

    type RelayReqOptions = {
        id?: string;
        reconnect?: boolean | number | Parameters<typeof retry>[0];
        resubscribe?: boolean | number | Parameters<typeof repeat>[0];
        waitForAuth?: boolean;
    }
    Index

    Properties

    id? reconnect? resubscribe? waitForAuth?

    Properties

    id?: string

    Custom REQ id for the subscription

    reconnect?: boolean | number | Parameters<typeof retry>[0]

    Whether to reconnect when socket is closed. default is true (3 retries with 1 second delay)

    https://rxjs.dev/api/index/function/retry

    resubscribe?: boolean | number | Parameters<typeof repeat>[0]

    Whether to resubscribe if the subscription is closed by the relay. default is false

    https://rxjs.dev/api/index/function/repeat

    waitForAuth?: boolean

    Whether to wait for authentication and retry if auth-required is received. default is true

    Settings

    Member Visibility

    On This Page

    Properties