Socket SDK Constructor

import { QPub } from "@qpub/sdk";

const socket = new QPub.Socket({
  apiKey: process.env.QPUB_API_KEY,
});

Options

Pass a partial options object. Important fields:

Option	Default	Description
`apiKey`	—	API key `publicId:secret`
`authUrl`	—	POST URL that returns `{ token }` or `{ tokenRequest }`
`authOptions`	—	`{ headers?, body? }` for `authUrl`
`tokenRequest`	—	Pre-signed token request; fetches JWT on init
`alias`	—	Client alias
`httpHost`	`rest.qpub.io`	Host for token/HTTP auth helpers
`httpPort`	`null`	Optional port
`wsHost`	`socket.qpub.io`	WebSocket host
`wsPort`	`null`	Optional port
`isSecure`	`true`	`wss`/`https` vs `ws`/`http`
`autoConnect`	`true`	Connect on construct
`autoReconnect`	`true`	Reconnect with backoff
`autoResubscribe`	`true`	Resubscribe after reconnect
`autoAuthenticate`	`true`	Authenticate before connect
`connectTimeoutMs`	`10000`	Connect timeout
`maxReconnectAttempts`	`10`	Reconnect limit
`initialReconnectDelayMs`	`1000`	Backoff start
`maxReconnectDelayMs`	`30000`	Backoff cap
`reconnectBackoffMultiplier`	`1.5`	Backoff factor
`authenticateRetries`	`3`	Auth retry count
`authenticateRetryIntervalMs`	`1000`	Auth retry delay
`pingTimeoutMs`	`10000`	Ping timeout
`debug`	`false`	Debug logging
`logLevel`	`"error"`	`error` \| `warn` \| `info` \| `debug` \| `trace`
`logger`	—	Custom logger function

resubscribeIntervalMs exists on the options type but is not used yet.

Provide one of apiKey, authUrl, or tokenRequest (depending on your auth flow).

Property / method	Description
`socket.connection`	Connection API and events — Connection
`socket.channels`	Channel manager — Channels
`socket.auth`	Auth manager (authenticate, tokens)
`socket.optionManager`	Runtime options
`socket.reset()`	Reset instance state
`socket.getInstanceId()`	Instance id string
`socket.getAbortSignal()`	AbortSignal for in-flight work

Method	Typical use	Where to run
`authenticate()`	Run configured auth flow	Client
`requestToken(tokenRequest)`	Exchange signed request for JWT	Client
`generateToken(opts?)`	Sign a JWT locally with the API key secret	Server / trusted
`issueToken(opts?)`	Request a platform-issued JWT	Server / trusted
`createTokenRequest(opts?)`	Create a signed token request for client-side exchange	Server / trusted
`clearToken()`	Drop active token	Client
`getAuthHeaders()`	Header map for HTTP	Client

Also see @qpub/sdk/react for SocketProvider, useConnection, useChannel, useAuth.