Aborter class

Пакет:

azure-maps-rest

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

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

aborted

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

aborted: boolean

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

boolean

none

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

static none: Aborter

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

Aborter

onabort

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

onabort?: (ev?: Event) => any

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

(ev?: Event) => any

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

abort()

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

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

function abort()

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

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

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

Параметры

_type

"abort"

Поддержка только события "прервать"

listener

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

getValue(string)

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

function getValue(key: string): string | number | boolean | null | undefined

Параметры

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"

Поддержка только события "прервать"

listener

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

timeout(number)

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

static function timeout(timeout: number): Aborter

Параметры

timeout

number

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

Aborter

withTimeout(number)

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

function withTimeout(timeout: number): Aborter

Параметры

timeout

number

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

Aborter

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

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

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

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

Параметры

key

string

value

string | number | boolean | null

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

Aborter