Interface RpcSubscriptionsTransportConfig<TNotification>

interface RpcSubscriptionsTransportConfig<TNotification> {
    execute: (
        config: Readonly<
            {
                channel: RpcSubscriptionsChannel<unknown, unknown>;
                signal: AbortSignal;
            },
        >,
    ) => Promise<
        DataPublisher<RpcSubscriptionsTransportDataEvents<TNotification>>,
    >;
    request: RpcRequest;
    signal: AbortSignal;
}

Type Parameters

  • TNotification

Hierarchy (View Summary)

Properties

execute request signal

Properties

Readonlyexecute

execute: (
    config: Readonly<
        {
            channel: RpcSubscriptionsChannel<unknown, unknown>;
            signal: AbortSignal;
        },
    >,
) => Promise<
    DataPublisher<RpcSubscriptionsTransportDataEvents<TNotification>>,
>

This method may be called with a newly-opened channel or a pre-established channel.

Readonlyrequest

request: RpcRequest

This request is used to uniquely identify the subscription. It typically comes from the method name and parameters of the subscription call, after potentially being transformed by the RPC Subscriptions API.

signal

signal: AbortSignal

Settings

Member Visibility

On This Page

Properties