Interface DialOptions

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

Example

const controller = new AbortController()

aLongRunningOperation({
  signal: controller.signal
})

// later

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

Hierarchy (view full)

Properties

force? onProgress? signal?

Properties

Optional force

force?: boolean

If true, open a new connection to the remote even if one already exists

Optional onProgress

onProgress?: ((evt) => void)

Type declaration

    • (evt): void

    • Parameters

      • evt: any

      Returns void

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

forceonProgresssignal