Aborter class

Пакет:

@azure/storage-file

Экземпляр прерывания реализует интерфейс AbortSignal, может прервать HTTP-запросы.

• Вызовите Aborter.none, чтобы создать новый экземпляр Aborter без времени ожидания.
• Вызовите Aborter.timeout(), чтобы создать новый экземпляр Aborter с временем ожидания.

Для существующего экземпляра прервано:

• Вызовите aborter.withTimeout(), чтобы создать и вернуть дочерний экземпляр Aborter с временем ожидания.
• Вызовите aborter.withValue(key, value), чтобы создать и вернуть дочерний экземпляр Aborter с парой "ключ-значение".
• Вызовите aborter.abort(), чтобы прервать текущий экземпляр и все дочерние экземпляры.
• Вызовите aborter.getValue(key) для поиска и получения значения с соответствующим ключом от текущего прерывания для всех родителей.

Свойства

aborted	Состояние прерывания или нет.
none	Создает новый экземпляр Aborter без времени ожидания.
onabort	прослушиватель событий onabort.

Методы

abort()	Событие прерывания триггера немедленно активируется, onabort и все прослушиватели событий прерывания будут активированы. Попытается активировать событие прерывания для всех дочерних узлов Aborter. Если время ожидания истекло, таймер будет отменен. Если прервано, ничего не произойдет.
addEventListener("abort", (this: AbortSignalLike, ev: any) => any)	Добавлен новый прослушиватель событий abort, поддерживается только событие abort.
dispatchEvent()
getValue(string)	Узнайте последнее значение с соответствующим ключом в цепочке [текущего узла] -> [родительский узел] -> [главный родительский узел] -> ... -> [корневой узел]. Если ключ не найден, undefined будет возвращен.
removeEventListener("abort", (this: AbortSignalLike, ev: any) => any)	Удалите прослушиватель событий abort, поддерживая только событие abort.
timeout(number)	Создает новый экземпляр Aborter с временем ожидания в миллисекундах. Установка времени ожидания параметра в значение 0 не создаст таймер.
withTimeout(number)	Создайте и верните новый экземпляр Aborter, который будет добавлен в качестве дочернего узла текущего прерывания. Текущий экземпляр Aborter становится узлом отца нового экземпляра. Когда текущий или отец узла Aborter активирует событие времени ожидания, все дочерние узлы отменяются также. Если параметр времени ожидания (в миллисекундах) больше 0, событие прерывания будет активировано при истечении времени ожидания. В противном случае вызов метода abort() для ручного прерывания.
withValue(string, string | number | boolean | null)	Создайте и верните новый экземпляр Aborter, который будет добавлен в качестве дочернего узла текущего прерывания. Текущий экземпляр Aborter становится узлом отца нового экземпляра. Когда текущий или отец узла Aborter активирует событие времени ожидания, все дочерние узлы отменяются также. Неизменяемая пара значений ключа будет задана в новый созданный экземпляр Aborter. Вызовите getValue(), чтобы узнать последнее значение с соответствующим ключом в цепочке [текущего узла] -> [родительский узел] и [большой родительский узел]....

Сведения о свойстве

aborted

Состояние прерывания или нет.

aborted: boolean

Значение свойства

boolean

none

Создает новый экземпляр Aborter без времени ожидания.

static none: Aborter

Значение свойства

Aborter

onabort

прослушиватель событий onabort.

onabort: (this: AbortSignalLike, ev: any) => any | null

Значение свойства

(this: AbortSignalLike, ev: any) => any | null

Сведения о методе

abort()

Событие прерывания триггера немедленно активируется, onabort и все прослушиватели событий прерывания будут активированы. Попытается активировать событие прерывания для всех дочерних узлов Aborter.

• Если время ожидания истекло, таймер будет отменен.
• Если прервано, ничего не произойдет.

function abort()

addEventListener("abort", (this: AbortSignalLike, ev: any) => any)

Добавлен новый прослушиватель событий abort, поддерживается только событие abort.

function addEventListener(_type: "abort", listener: (this: AbortSignalLike, ev: any) => any)

Параметры

_type

"abort"

Только поддержка события abort

listener

(this: AbortSignalLike, ev: any) => any

dispatchEvent()

function dispatchEvent()

Возвращаемое значение

boolean

getValue(string)

Узнайте последнее значение с соответствующим ключом в цепочке [текущего узла] -> [родительский узел] -> [главный родительский узел] -> ... -> [корневой узел]. Если ключ не найден, undefined будет возвращен.

function getValue(key: string)

Параметры

key

string

Возвращаемое значение

string | number | boolean | null | undefined

removeEventListener("abort", (this: AbortSignalLike, ev: any) => any)

Удалите прослушиватель событий abort, поддерживая только событие abort.

function removeEventListener(_type: "abort", listener: (this: AbortSignalLike, ev: any) => any)

Параметры

_type

"abort"

Только поддержка события abort

listener

(this: AbortSignalLike, ev: any) => any

timeout(number)

Создает новый экземпляр Aborter с временем ожидания в миллисекундах. Установка времени ожидания параметра в значение 0 не создаст таймер.

static function timeout(timeout: number)

Параметры

timeout

number

Возвращаемое значение

Aborter

withTimeout(number)

Создайте и верните новый экземпляр Aborter, который будет добавлен в качестве дочернего узла текущего прерывания. Текущий экземпляр Aborter становится узлом отца нового экземпляра. Когда текущий или отец узла Aborter активирует событие времени ожидания, все дочерние узлы отменяются также. Если параметр времени ожидания (в миллисекундах) больше 0, событие прерывания будет активировано при истечении времени ожидания. В противном случае вызов метода abort() для ручного прерывания.

function withTimeout(timeout: number)

Параметры

timeout

number

Возвращаемое значение

Aborter

Созданный экземпляр Aborter.

withValue(string, string | number | boolean | null)

Создайте и верните новый экземпляр Aborter, который будет добавлен в качестве дочернего узла текущего прерывания. Текущий экземпляр Aborter становится узлом отца нового экземпляра. Когда текущий или отец узла Aborter активирует событие времени ожидания, все дочерние узлы отменяются также. Неизменяемая пара значений ключа будет задана в новый созданный экземпляр Aborter. Вызовите getValue(), чтобы узнать последнее значение с соответствующим ключом в цепочке [текущего узла] -> [родительский узел] и [большой родительский узел]....

function withValue(key: string, value?: string | number | boolean | null)

Параметры

key

string

value

string | number | boolean | null

Возвращаемое значение

Aborter