Interface SignalingRecoveryState

Return type of useSignalingRecovery.

interface SignalingRecoveryState {
    attempt: number;
    error: Error | null;
    reason: SignalingRecoveryFailureReason | null;
    status: SignalingRecoveryStatus;
}

Index

Properties

attempt error reason status

Properties

attempt

attempt: number

Attempts made in the current (or most recent) recovery. 0 while idle.

error

error: Error | null

The error behind a failed recovery, when the client reported one.

reason

reason: SignalingRecoveryFailureReason | null

Why the most recent recovery ended without reconnecting; null unless status is 'failed'.

status

status: SignalingRecoveryStatus

Current recovery status.