Skip to content

Documentation / @agentick/client / WSTransportConfig

Interface: WSTransportConfig ​

Defined in: client/src/ws-transport.ts:18

Properties ​

baseUrl ​

baseUrl: string

Defined in: client/src/ws-transport.ts:20

Base URL for the server (http:// or ws://)


clientId? ​

optional clientId: string

Defined in: client/src/ws-transport.ts:23

Client ID to use for connection


headers? ​

optional headers: Record<string, string>

Defined in: client/src/ws-transport.ts:29

Custom headers (passed to WebSocket implementations that support them)


reconnect? ​

optional reconnect: object

Defined in: client/src/ws-transport.ts:41

Reconnection settings

delay? ​

optional delay: number

Delay between attempts in ms (default: 1000)

enabled? ​

optional enabled: boolean

Enable auto-reconnection (default: true)

maxAttempts? ​

optional maxAttempts: number

Max reconnection attempts (default: 5)


timeout? ​

optional timeout: number

Defined in: client/src/ws-transport.ts:32

Request timeout in ms (default: 30000)


token? ​

optional token: string

Defined in: client/src/ws-transport.ts:26

Authentication token


WebSocket()? ​

optional WebSocket: (url, protocols?) => WebSocket

Defined in: client/src/ws-transport.ts:38

WebSocket implementation (for Node.js compatibility)

Parameters ​

url ​

string | URL

protocols? ​

string | string[] | WebSocketInit

Returns ​

WebSocket


withCredentials? ​

optional withCredentials: boolean

Defined in: client/src/ws-transport.ts:35

Send credentials with requests

Released under the ISC License.