Interface UpgraderOptions<ConnectionUpgradeEvents>

An object that contains an AbortSignal as the optional signal property.

Example

const controller = new AbortController()

aLongRunningOperation({
signal: controller.signal
})

// later

controller.abort()
interface UpgraderOptions<ConnectionUpgradeEvents> {
    limits?: ConnectionLimits;
    muxerFactory?: StreamMuxerFactory;
    onProgress?: ((evt) => void);
    signal?: AbortSignal;
    skipEncryption?: boolean;
    skipProtection?: boolean;
}

Type Parameters

Hierarchy (view full)

Properties

muxerFactory?: StreamMuxerFactory
onProgress?: ((evt) => void)

Type declaration

signal?: AbortSignal
skipEncryption?: boolean
skipProtection?: boolean