WebsocketAdapterOptionsType

---

Import

import { WebsocketAdapterOptionsType } from "@hyper-fetch/sockets"

Source

View the source code

Package

@hyper-fetch/sockets

Preview

type WebsocketAdapterOptionsType = {
  autoConnect?: boolean; 
  heartbeat?: boolean; 
  heartbeatMessage?: string; 
  pingTimeout?: number; 
  pongTimeout?: number; 
  protocols?: string | string[]; 
}

Structure

WebsocketAdapterOptionsType

Name	Type	Description
autoConnect	boolean
heartbeat	boolean
heartbeatMessage	string
pingTimeout	number
pongTimeout	number
protocols	string | string[]	Subprotocols passed to the WebSocket constructor ( Sec-WebSocket-Protocol header). To resolve them per connection attempt (e.g. short-lived auth tokens) use socket.onConnect .