Skip to main content
Version: v8.0.0

SocketSdkInstance

The fully-resolved Socket SDK instance type returned by createSocketSdk .

The schema is rewritten via InjectSocket so every Listener / Emitter leaf carries the actual socket type passed to createSocketSdk(socket)

  • users do not need to repeat socket: AppSocket in every ListenerModel<{...}> / EmitterModel<{...}>

declaration.


Import
import { SocketSdkInstance } from "@hyper-fetch/sockets"

Preview

type SocketSdkInstance<Schema,S> = InjectSocket<Schema, S> & { $configure: (defaults: SocketSdkConfigurationMap<Schema>) => SocketSdkInstance<Schema, S> };

Structure

SocketSdkInstance
NameTypeDescription
$configure
(defaults: SocketSdkConfigurationMap<Schema>) => SocketSdkInstance<Schema, S>