Aborter class

Pacote:

azure-maps-rest

Uma instância de anulador implementa a interface AbortSignal, pode anular solicitações HTTP.

• Chame Aborter.none para criar uma nova instância do Abortador sem tempo limite.
• Chame Aborter.timeout() para criar uma nova instância do Aborter com tempo limite.

Para um anulador de instância existente:

• Chame aborter.withTimeout() para criar e retornar uma instância de Abortador filho com tempo limite.
• Chame aborter.withValue(key, value) para criar e retornar uma instância de Abortador filho com par chave/valor.
• Chame aborter.abort() para anular a instância atual e todas as instâncias filho.
• Chame aborter.getValue(key) para pesquisar e obter valor com a chave correspondente do abortador atual para todos os pais.

Propriedades

aborted	Status de anulação ou não.
none	Cria uma nova instância do Abortador sem tempo limite.
onabort	ouvinte de eventos onabort.

Métodos

abort()	Dispare o evento de anulação imediatamente, o onabort e todos os ouvintes de eventos de anulação serão disparados. Tentará disparar um evento de anulação para todos os nós anuladores filhos. Se houver um tempo limite, o temporizador será cancelado. Se abortado for verdade, nada acontecerá.
addEventListener("abort", (this: AbortSignalLike, ev: any) => any)	Adicionado o novo ouvinte de eventos "abort", só dá suporte ao evento "abort".
getValue(string)	Descubra o valor mais recente com chave correspondente na cadeia de [nó atual] -> [nó pai] -> [nó pai principal] -> ... -> [nó raiz]. Se a chave não for encontrada, indefinido será retornado.
removeEventListener("abort", (this: AbortSignalLike, ev: any) => any)	Remova o ouvinte de eventos "abort" e dê suporte apenas ao evento "abort".
timeout(number)	Cria uma nova instância do Aborter com tempo limite em milissegundos. Definir o tempo limite do parâmetro como 0 não criará um temporizador.
withTimeout(number)	Crie e retorne uma nova instância do Abortador, que será acrescentada como um nó filho do Abortador atual. A instância do Abortador atual torna-se um nó pai da nova instância. Quando o nó do Abortador atual ou pai dispara o evento de tempo limite, o evento de anulação de todos os nós filhos também será disparado. Quando o parâmetro timeout (em milissegundos) for maior que 0, o evento de anulação será disparado quando o tempo limite for atingido. Caso contrário, chame o método abort() para anular manualmente.
withValue(string, string | number | boolean | null)	Crie e retorne uma nova instância do Abortador, que será acrescentada como um nó filho do Abortador atual. A instância do Abortador atual torna-se um nó pai da nova instância. Quando o nó do Abortador atual ou pai dispara o evento de tempo limite, todos os nós filhos anulam o evento também serão disparados. O par de valores de chave imutáveis será definido na nova instância do Abortador criada. Chame getValue() para descobrir o valor mais recente com a chave correspondente na cadeia de [nó atual] -> [nó pai] e [nó pai geral]....

Detalhes da propriedade

aborted

Status de anulação ou não.

aborted: boolean

Valor da propriedade

boolean

none

Cria uma nova instância do Abortador sem tempo limite.

static none: Aborter

Valor da propriedade

Aborter

onabort

ouvinte de eventos onabort.

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

Valor da propriedade

(ev?: Event) => any

Detalhes do método

abort()

Dispare o evento de anulação imediatamente, o onabort e todos os ouvintes de eventos de anulação serão disparados. Tentará disparar um evento de anulação para todos os nós anuladores filhos.

• Se houver um tempo limite, o temporizador será cancelado.
• Se abortado for verdade, nada acontecerá.

function abort()

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

Adicionado o novo ouvinte de eventos "abort", só dá suporte ao evento "abort".

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

Parâmetros

_type

"abort"

Suporte apenas ao evento "abort"

listener

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

getValue(string)

Descubra o valor mais recente com chave correspondente na cadeia de [nó atual] -> [nó pai] -> [nó pai principal] -> ... -> [nó raiz]. Se a chave não for encontrada, indefinido será retornado.

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

Parâmetros

key

string

Retornos

string | number | boolean | null | undefined

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

Remova o ouvinte de eventos "abort" e dê suporte apenas ao evento "abort".

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

Parâmetros

_type

"abort"

Suporte apenas ao evento "abort"

listener

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

timeout(number)

Cria uma nova instância do Aborter com tempo limite em milissegundos. Definir o tempo limite do parâmetro como 0 não criará um temporizador.

static function timeout(timeout: number): Aborter

Parâmetros

timeout

number

Retornos

Aborter

withTimeout(number)

Crie e retorne uma nova instância do Abortador, que será acrescentada como um nó filho do Abortador atual. A instância do Abortador atual torna-se um nó pai da nova instância. Quando o nó do Abortador atual ou pai dispara o evento de tempo limite, o evento de anulação de todos os nós filhos também será disparado. Quando o parâmetro timeout (em milissegundos) for maior que 0, o evento de anulação será disparado quando o tempo limite for atingido. Caso contrário, chame o método abort() para anular manualmente.

function withTimeout(timeout: number): Aborter

Parâmetros

timeout

number

Retornos

Aborter

A nova instância do Abortador criada.

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

Crie e retorne uma nova instância do Abortador, que será acrescentada como um nó filho do Abortador atual. A instância do Abortador atual torna-se um nó pai da nova instância. Quando o nó do Abortador atual ou pai dispara o evento de tempo limite, todos os nós filhos anulam o evento também serão disparados. O par de valores de chave imutáveis será definido na nova instância do Abortador criada. Chame getValue() para descobrir o valor mais recente com a chave correspondente na cadeia de [nó atual] -> [nó pai] e [nó pai geral]....

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

Parâmetros

key

string

value

string | number | boolean | null

Retornos

Aborter