Interface OpenConnectionOptions

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

Example

const controller = new AbortController()

aLongRunningOperation({
  signal: controller.signal
})

// later

controller.abort()
interface OpenConnectionOptions {
    force?: boolean;
    onProgress?: ((evt) => void);
    priority?: number;
    signal?: AbortSignal;
}

Hierarchy (view full)

Properties

force? onProgress? priority? signal?

Properties

Optional force

force?: boolean

When opening a connection to a remote peer, if a connection already exists it will be returned instead of creating a new connection. Pass true here to override that and dial a new connection anyway.

Default

false

Optional onProgress

onProgress?: ((evt) => void)

Type declaration

Optional priority

priority?: number

Connection requests with a higher priority will be executed before those with a lower priority.

Default

50

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

forceonProgressprioritysignal