API reference

Everything on this page comes from @dammers/use-signalr-core. The package exports functions and types. It has no default export.

SessionCopy Anchor Link

createSignalRSessionCopy Anchor Link

createSignalRSession has this signature:

function createSignalRSession<
  T extends SignalRContract,
  TStore extends StatusStore<keyof T & HubString> = StatusStore<keyof T & HubString>,
>(deps: SignalRSessionDeps<T, TStore>): SignalRSession<T, TStore>;

Creates a session. The session owns the live connections, the lazy reference counts, the reconnect listeners, the event registry, and the context value. Construction does no I/O. See Build an adapter for the contract.

SignalRSessionDepsCopy Anchor Link

SignalRSessionValuesCopy Anchor Link

The values that a provider applies.

SignalRSessionCopy Anchor Link

ContextCopy Anchor Link

SignalRPublicContextCopy Anchor Link

waitForConnection rejects in these cases:

• The timeout of timeoutMs ends. The error has the name SignalRTimeoutError. Infinity waits without a limit.
• The signal aborts. The error is signal.reason, which is an AbortError for a plain abort().
• The last update disabled the session. The error has the name SignalRDisabledError.
• The hub stopped after a non-retriable error. The error has the name SignalRDisconnectedError.

During server rendering no connection starts. The wait ends with the timeout, or rejects at once if the adapter disables the session on the server.

SignalRContextValueBaseCopy Anchor Link

The full context for the hooks of an adapter. It is not public API for app code.

SignalRProviderPropsBaseCopy Anchor Link

The props that every provider takes. Extend this type with the framework parts, such as a children prop.

StatusStoreCopy Anchor Link

The per-hub status store that an adapter implements.

CallsCopy Anchor Link

createInvokerCopy Anchor Link

createInvoker has this signature:

function createInvoker<
  T extends SignalRContract,
  H extends keyof T & HubString,
  M extends MethodName<T, H>,
>(options: InvokerOptions<T, H, M>): (...args: MethodArgs<T, H, M>) => Promise<MethodReturn<T, H, M>>;

Builds the invoke function for one hub method. The function waits for the connection, calls connection.invoke, and resolves with the return value. The default timeout is 10 000 ms for each attempt. The default for retries is 0.

The default retry rule decides which failures retry. The isRetriable option overrides it. An abort always wins, and the error reaches the caller.

InvokerOptionsCopy Anchor Link

CallTargetCopy Anchor Link

The members of the context that the invoker needs.

createSenderCopy Anchor Link

createSender has this signature:

function createSender<
  T extends SignalRContract,
  H extends keyof T & HubString,
  M extends MethodName<T, H>,
>(options: {
  getConnection: (hub: H) => HubConnection | null;
  hub: H;
  method: M;
}): (...args: MethodArgs<T, H, M>) => Promise<boolean>;

Builds a fire-and-forget function. It reads the connection at call time and does not wait. It resolves true when it sends the call. It resolves false when the hub is not connected or when send rejects. It never rejects.

createTeardownSenderCopy Anchor Link

createTeardownSender has this signature:

function createTeardownSender<
  T extends SignalRContract,
  H extends keyof T & HubString,
  M extends MethodName<T, H>,
>(options: {
  target: {
    acquire: (hub: H) => void;
    release: (hub: H) => void;
    waitForConnection: (hub: H, timeoutMs: number) => Promise<HubConnection>;
  };
  hub: H;
  method: M;
  getOptions: () => TeardownOptions | undefined;
}): (...args: MethodArgs<T, H, M>) => Promise<boolean>;

Builds a function for a call in a cleanup. It acquires the hub, so it works after its consumer is gone. It releases the hub when the call ends. It waits for the connection up to the timeout (default 10 000 ms). It resolves true when it sends the call. It resolves false when the hub did not connect in time, the session is disabled, the hub failed, or send rejects. It never rejects.

createAbortScopeCopy Anchor Link

createAbortScope has this signature:

function createAbortScope(): AbortScope;

Creates one shared signal for all in-flight calls of a consumer.

AbortScopeCopy Anchor Link

ConfigCopy Anchor Link

hubKeysCopy Anchor Link

hubKeys has this signature:

function hubKeys<H extends Record<HubString, HubDef>>(
  config: SignalRClientConfig<H>,
): Array<keyof H & HubString>;

Returns the hub paths of a config, typed as the declared hubs.

resolveHubConfigCopy Anchor Link

resolveHubConfig has this signature:

function resolveHubConfig<H extends Record<HubString, HubDef>>(
  config: SignalRClientConfig<H>,
  hub: keyof H & HubString,
): ResolvedHubConfig;

Merges the per-hub config over the global config and applies the defaults. It throws an Error for a config that cannot work. These configs fail:

• The keys transport, skipNegotiation, and maxConnectRetries at the top level or on a hub.
• skipNegotiation without the WebSockets transport.
• A binary protocol object with the Server-Sent Events transport.

Call it once for each hub when you create the client.

ContractCopy Anchor Link

eventCopy Anchor Link

event has this signature:

function event<A extends unknown[] = []>(): EventDef<A>;

Declares a server-pushed event, for example event<[user: string, message: string]>().

methodCopy Anchor Link

method has this signature:

function method<A extends unknown[] = [], R = void>(): MethodDef<A, R>;

Declares an invocable server method, for example method<[roomId: string], boolean>().

TypesCopy Anchor Link

Contract typesCopy Anchor Link

Status and error typesCopy Anchor Link

Config typesCopy Anchor Link

See the config reference for the options.

Call option typesCopy Anchor Link