Core

WebSocketState

Lifecycle state of a managed WebSocket session.

Chapter navigation

@defjs/core · Type

Signature

type WebSocketState =
  | "aborted"
  | "closed"
  | "closing"
  | "connecting"
  | "error"
  | "idle"
  | "open"
  | "reconnecting";

State	Meaning
`idle`	Before the first connect attempt
`connecting`	Preparing and opening the first connection
`open`	The physical socket is open
`reconnecting`	Preparing or waiting for a replacement socket after a close
`closing`	Closure was requested with `session.close()` or disposal
`closed`	Terminal: the session ended without an error or cancellation
`aborted`	Terminal: the session was cancelled through `signal`
`error`	Terminal: the session failed, including a startup failure or `timeout`

Observe it with session.state and session.onStateChange.

WebSocketSessionLike

Minimal WebSocket session surface that interceptors see.

withCredentials

Sets whether HTTP and SSE requests include credentials.