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

limits? muxerFactory? onProgress? signal? skipEncryption? skipProtection?

Properties

Optional limits

limits?: ConnectionLimits

Optional muxerFactory

muxerFactory?: StreamMuxerFactory

Optional onProgress

onProgress?: ((evt) => void)

Type declaration

Optional signal

signal?: AbortSignal

Optional skipEncryption

skipEncryption?: boolean

Optional skipProtection

skipProtection?: boolean

Settings

Member Visibility

Theme

On This Page

limitsmuxerFactoryonProgresssignalskipEncryptionskipProtection