SignalWireOptions
Options for constructing a SignalWire.
Properties
debug
Debug options for verbose SDK diagnostics (e.g., { logWsTraffic: true }). See DebugOptions.
logger
Custom logger implementation. Must implement the SDKLogger interface. Pass null to restore the built-in logger. Note: Logger configuration is global — setting it on one instance affects all instances.
logLevel
Log level for the built-in logger. Default: 'warn'. Set to 'debug' for verbose SDK output. Has no effect when a custom logger is provided. Note: Logger configuration is global — setting it on one instance affects all instances. See LogLevel.
persistSession
Persist the session across page reloads. When true, credential, authorization state, and protocol are stored in localStorage (survives reload). The DPoP key pair is persisted in IndexedDB. On reload, the SDK restores the session from cache without calling credentialProvider.authenticate(). When false (default), session data lives in sessionStorage and is lost on reload. Call destroy() to clear all persisted state (explicit logout).
reconnectAttachedCalls
Whether to reconnect to previously attached calls.
savePreferences
Whether to save preferences.
skipConnection
Skip automatic WebSocket connection on construction.
skipDeviceMonitoring
Skip monitoring media device changes.
skipRegister
Skip automatic user registration on construction.
storageImplementation
Custom storage implementation for persistence. See Storage.
webRTCApiProvider
Custom WebRTC API provider. See WebRTCApiProvider.
webSocketConstructor
Custom WebSocket constructor. See NodeSocketAdapter and WebSocketAdapter.