Share via

Aborter class

  • Referencia
Paquete:
azure-maps-rest

Una instancia del abortador implementa la interfaz AbortSignal, puede anular las solicitudes HTTP.

  • Llame a Aborter.none para crear una nueva instancia de Aborter sin tiempo de espera.
  • Llame a Aborter.timeout() para crear una nueva instancia de Aborter con tiempo de espera.

Para un abortador de instancia existente:

  • Llame a aborter.withTimeout() para crear y devolver una instancia de Aborter secundaria con el tiempo de espera.
  • Llame a aborter.withValue(key, value) para crear y devolver una instancia de Aborter secundaria con par clave-valor.
  • Llame a aborter.abort() para anular la instancia actual y todas las instancias secundarias.
  • Llame a aborter.getValue(key) para buscar y obtener valor con la clave correspondiente del abortador actual a todos los elementos primarios.

Propiedades

aborted

Estado de si se anula o no.
none

Crea una nueva instancia de Aborter sin tiempo de espera.
onabort

agente de escucha de eventos onabort.

Métodos

abort()

Desencadene el evento abort inmediatamente, se desencadenarán los agentes de escucha de eventos onabort y todos los agentes de escucha de eventos de anulación. Intentará desencadenar el evento abort para todos los nodos abortadores secundarios.

  • Si hay un tiempo de espera, se cancelará el temporizador.
  • Si se anula es true, no ocurrirá nada.
addEventListener("abort", (this: AbortSignalLike, ev: any) => any)

Se ha agregado el nuevo agente de escucha de eventos "abort", solo admite el evento "abort".
getValue(string)

Descubra el valor más reciente con la clave correspondiente en la cadena de [nodo actual] -> [nodo primario] -> [nodo principal] -> ... -> [nodo raíz]. Si no se encuentra la clave, se devolverá undefined.
removeEventListener("abort", (this: AbortSignalLike, ev: any) => any)

Quite el agente de escucha de eventos "abort", solo admite el evento "abort".
timeout(number)

Crea una nueva instancia de Aborter con tiempo de espera en milisegundos. Establezca el tiempo de espera del parámetro en 0 no creará un temporizador.
withTimeout(number)

Cree y devuelva una nueva instancia de Aborter, que se anexará como un nodo secundario del abortador actual. La instancia de Aborter actual se convierte en el nodo primario de la nueva instancia. Cuando el nodo abortador actual o primario desencadena un evento de tiempo de espera, también se desencadenará el evento de anulación de todos los nodos secundarios. Cuando el parámetro timeout (en milisegundos) es mayor que 0, el evento abort se desencadenará cuando se haya agotado el tiempo de espera. De lo contrario, llame al método abort() para anular manualmente.
withValue(string, string | number | boolean | null)

Cree y devuelva una nueva instancia de Aborter, que se anexará como un nodo secundario del abortador actual. La instancia de Aborter actual se convierte en el nodo primario de la nueva instancia. Cuando el nodo abortador actual o primario desencadena un evento de tiempo de espera, también se desencadenará el evento de anulación de todos los nodos secundarios. El par de valores de clave inmutable se establecerá en la nueva instancia de Aborter creada. Llame a getValue() para averiguar el valor más reciente con la clave correspondiente en la cadena de [nodo actual] -> [nodo primario] y [nodo primario general]....

Detalles de las propiedades

aborted

Estado de si se anula o no.

aborted: boolean

Valor de propiedad

boolean

none

Crea una nueva instancia de Aborter sin tiempo de espera.

static none: Aborter

Valor de propiedad

Aborter

onabort

agente de escucha de eventos onabort.

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

Valor de propiedad

(ev?: Event) => any

Detalles del método

abort()

Desencadene el evento abort inmediatamente, se desencadenarán los agentes de escucha de eventos onabort y todos los agentes de escucha de eventos de anulación. Intentará desencadenar el evento abort para todos los nodos abortadores secundarios.

  • Si hay un tiempo de espera, se cancelará el temporizador.
  • Si se anula es true, no ocurrirá nada.
function abort()

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

Se ha agregado el nuevo agente de escucha de eventos "abort", solo admite el evento "abort".

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

Parámetros

_type

"abort"

Solo admite el evento "abort"

listener

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

getValue(string)

Descubra el valor más reciente con la clave correspondiente en la cadena de [nodo actual] -> [nodo primario] -> [nodo principal] -> ... -> [nodo raíz]. Si no se encuentra la clave, se devolverá undefined.

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

Parámetros

key

string

Devoluciones

string | number | boolean | null | undefined

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

Quite el agente de escucha de eventos "abort", solo admite el evento "abort".

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

Parámetros

_type

"abort"

Solo admite el evento "abort"

listener

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

timeout(number)

Crea una nueva instancia de Aborter con tiempo de espera en milisegundos. Establezca el tiempo de espera del parámetro en 0 no creará un temporizador.

static function timeout(timeout: number): Aborter

Parámetros

timeout

number

Devoluciones

Aborter

withTimeout(number)

Cree y devuelva una nueva instancia de Aborter, que se anexará como un nodo secundario del abortador actual. La instancia de Aborter actual se convierte en el nodo primario de la nueva instancia. Cuando el nodo abortador actual o primario desencadena un evento de tiempo de espera, también se desencadenará el evento de anulación de todos los nodos secundarios. Cuando el parámetro timeout (en milisegundos) es mayor que 0, el evento abort se desencadenará cuando se haya agotado el tiempo de espera. De lo contrario, llame al método abort() para anular manualmente.

function withTimeout(timeout: number): Aborter

Parámetros

timeout

number

Devoluciones

Aborter

Nueva instancia de Aborter creada.

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

Cree y devuelva una nueva instancia de Aborter, que se anexará como un nodo secundario del abortador actual. La instancia de Aborter actual se convierte en el nodo primario de la nueva instancia. Cuando el nodo abortador actual o primario desencadena un evento de tiempo de espera, también se desencadenará el evento de anulación de todos los nodos secundarios. El par de valores de clave inmutable se establecerá en la nueva instancia de Aborter creada. Llame a getValue() para averiguar el valor más reciente con la clave correspondiente en la cadena de [nodo actual] -> [nodo primario] y [nodo primario general]....

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

Parámetros

key

string

value

string | number | boolean | null

Devoluciones

Aborter