preflight

1
preflight(destination, options?): Promise<PreflightResult>

Runs a multi-phase connectivity test against the given destination.

The test checks:

1. Signaling — WebSocket connected, RTT measurement
2. Devices — getUserMedia succeeds with selected (or specified) devices
3. ICE/TURN — gathers ICE candidates to verify STUN/TURN reachability
4. Media/bandwidth (unless skipMediaTest) — dials the destination, collects getStats() for duration seconds, computes bandwidth estimates

Parameters

Returns

Promise<PreflightResult>

A PreflightResult describing connectivity health.

Examples

1
const result = await client.preflight('/private/network-test', { duration: 5 });
2
if (!result.ok) console.warn('Connectivity issues:', result.warnings);