Interface BroadcastQuerySubscriptionOptions<C>

interface BroadcastQuerySubscriptionOptions<C extends ChannelDefinition> {
    channel: C;
    client: BroadcastClient;
    invalidates: (
        event: InferChannelEvent<C>,
    ) => readonly QueryFilters<readonly unknown[]>[];
    onError?: (error: unknown) => void;
    onStatusChange?: (
        status: BroadcastClientStatus,
        info: BroadcastConnectionInfo,
    ) => void;
    onSync?: (info: BroadcastConnectionInfo) => void | Promise<void>;
    params: InferChannelParams<C>;
    queryClient: QueryClient;
    reconciles: readonly QueryFilters<readonly unknown[]>[];
    refreshGate?: BroadcastRefreshGate;
}

Type Parameters

C extends ChannelDefinition

Index

Properties

channel client invalidates onError? onStatusChange? onSync? params queryClient reconciles refreshGate?

Properties

channel

channel: C

client

client: BroadcastClient

invalidates

invalidates: (
event: InferChannelEvent<C>,
) => readonly QueryFilters<readonly unknown[]>[]

`Optional`onError

onError?: (error: unknown) => void

`Optional`onStatusChange

onStatusChange?: (
status: BroadcastClientStatus,
info: BroadcastConnectionInfo,
) => void

`Optional`onSync

onSync?: (info: BroadcastConnectionInfo) => void | Promise<void>

Readiness notification; queued reconciliation may still be blocked by the gate.

params

params: InferChannelParams<C>

queryClient

queryClient: QueryClient

reconciles

reconciles: readonly QueryFilters<readonly unknown[]>[]

All state covered by the channel, including unread counters and filtered lists.

`Optional`refreshGate

refreshGate?: BroadcastRefreshGate