For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReferenceClick-to-Call
GuidesReferenceClick-to-Call
  • Core
    • Overview
  • Entities
    • SignalWire
    • Address
    • Participant
    • ClientPreferences
    • SelfCapabilities
    • SelfParticipant
    • User
    • WebRTCCall
      • CallCreateError
      • CollectionFetchError
      • DeviceTokenError
      • DPoPInitError
      • InvalidCredentialsError
      • MediaTrackError
      • MessageParseError
      • OverconstrainedFallbackError
      • PreflightError
      • RecoveryError
      • TokenRefreshError
      • UnexpectedError
      • VertoPongError
  • Web Components
    • Overview
    • sw-audio-level
    • sw-call-controls
    • sw-call-dialpad
    • sw-call-media
    • sw-call-provider
    • sw-call-status
    • sw-call-widget
    • sw-click-to-call
    • sw-device-selector
    • sw-directory
    • sw-local-camera
    • sw-participant-controls
    • sw-participants
    • sw-self-media
    • sw-ui-alert
    • sw-ui-background
    • sw-ui-call-layout
    • sw-ui-content-drawer
    • sw-ui-control-bar
    • sw-ui-dialpad
    • sw-ui-dropup
    • sw-ui-icon
    • sw-ui-modal
    • sw-ui-responsive-container
    • sw-ui-split-button
    • sw-ui-transcript-view
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Extends
  • Constructors
  • Constructor
  • Parameters
  • Properties
  • Examples
EntitiesErrors

PreflightError

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

RecoveryError

Next
Built with

Raised by SignalWire.preflight when the connectivity test fails at one of its phases. Inspect phase to discriminate (signaling, media, connectivity) — failure at the signaling phase usually means the user’s network blocks the transport; failure at the media phase usually means device-permission or codec issues.

Extends

  • Error

Constructors

Constructor

1new PreflightError(phase, originalError?): PreflightError

Parameters

phase
stringRequired

Preflight phase where the failure occurred (e.g. signaling, media, connectivity).

originalError
unknown

Underlying error raised during preflight.

Properties

originalError
unknown

Underlying error raised during preflight.

phase
stringRequired

Preflight phase where the failure occurred (e.g. signaling, media, connectivity).

Examples

1import { PreflightError } from '@signalwire/js';
2
3try {
4 const result = await client.preflight('/preflight-endpoint');
5} catch (err) {
6 if (err instanceof PreflightError) {
7 console.error(`preflight failed at ${err.phase}:`, err.originalError);
8 }
9}