UseSubscriptionOptions

type UseSubscriptionOptions = object;

Options accepted by useSubscription.

Properties

getAbortSignal?

optional getAbortSignal?: () => AbortSignal;

Factory invoked on every connection (initial subscribe + every reconnect()). The returned signal is attached to that connection via the underlying store's withSignal(signal).connect(), so aborting it tears down that connection.

The most common use is per-connection timeouts: getAbortSignal: () => AbortSignal.timeout(30_000) gives every connection its own 30-second clock that resets on reconnect().

Held in a ref synced to the latest render's closure — there is no need to memoize an inline factory.

Returns

AbortSignal