Condividi tramite

Aborter class

  • Riferimento
Pacchetto:
@azure/storage-queue

Un'istanza di interruzione implementa l'interfaccia AbortSignal, può interrompere le richieste HTTP.

  • Chiamare Aborter.none per creare una nuova istanza di Aborter senza timeout.
  • Chiamare Aborter.timeout() per creare una nuova istanza di Aborter con timeout.

Per un interruzione dell'istanza esistente:

  • Chiamare aborter.withTimeout() per creare e restituire un'istanza di Aborter figlio con timeout.
  • Chiamare aborter.withValue(key, value) per creare e restituire un'istanza figlio di Aborter con coppia chiave/valore.
  • Chiamare aborter.abort() per interrompere l'istanza corrente e tutte le istanze figlio.
  • Chiamare aborter.getValue(key) per cercare e ottenere valore con la chiave corrispondente dall'interruzione corrente a tutti i genitori.

Proprietà

aborted

Stato dell'interruzione o meno.
none

Crea una nuova istanza di Aborter senza timeout.
onabort

listener eventi onabort.

Metodi

abort()

Attiva immediatamente l'evento di interruzione, verrà attivato l'onabort e tutti i listener eventi di interruzione. Tenterà di attivare l'evento di interruzione per tutti i nodi Aborter figlio.

  • Se è presente un timeout, il timer verrà annullato.
  • Se interrotto è vero, non accadrà nulla.
addEventListener("abort", (this: AbortSignalLike, ev: any) => any)

Aggiunto il nuovo listener eventi "abort", supporta solo l'evento "abort".
dispatchEvent()
getValue(string)

Scopri il valore più recente con la chiave corrispondente nella catena di [nodo corrente] - [nodo padre] -> [nodo padre]>> - ...> - [nodo radice]. Se la chiave non viene trovata, verrà restituita una chiave non definita.
removeEventListener("abort", (this: AbortSignalLike, ev: any) => any)

Rimuovere il listener eventi "abort", supporta solo l'evento "abort".
timeout(number)

Crea una nuova istanza di Aborter con timeout in millisecondi. Impostare il timeout dei parametri su 0 non creerà un timer.
withTimeout(number)

Creare e restituire una nuova istanza di Aborter, che verrà aggiunta come nodo figlio dell'interruzione corrente. L'istanza di Aborter corrente diventa nodo padre della nuova istanza. Quando il nodo Aborter corrente o padre attiva l'evento di timeout, anche tutti i nodi figlio interromperanno l'evento. Quando il parametro timeout (in millisecondo) è maggiore di 0, l'evento di interruzione verrà attivato quando timeout. In caso contrario, chiamare il metodo abort() per interrompere manualmente.
withValue(string, string | number | boolean | null)

Creare e restituire una nuova istanza di Aborter, che verrà aggiunta come nodo figlio dell'interruzione corrente. L'istanza di Aborter corrente diventa nodo padre della nuova istanza. Quando il nodo Aborter corrente o padre attiva l'evento di timeout, anche tutti i nodi figlio interromperanno l'evento. La coppia valore chiave non modificabile verrà impostata nella nuova istanza di Aborter creata. Chiamare getValue() per scoprire il valore più recente con la chiave corrispondente nella catena di [nodo corrente] -> [nodo padre] e [nodo padre]....

Dettagli proprietà

aborted

Stato dell'interruzione o meno.

aborted: boolean

Valore della proprietà

boolean

none

Crea una nuova istanza di Aborter senza timeout.

static none: Aborter

Valore della proprietà

Aborter

onabort

listener eventi onabort.

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

Valore della proprietà

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

Dettagli metodo

abort()

Attiva immediatamente l'evento di interruzione, verrà attivato l'onabort e tutti i listener eventi di interruzione. Tenterà di attivare l'evento di interruzione per tutti i nodi Aborter figlio.

  • Se è presente un timeout, il timer verrà annullato.
  • Se interrotto è vero, non accadrà nulla.
function abort()

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

Aggiunto il nuovo listener eventi "abort", supporta solo l'evento "abort".

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

Parametri

_type

"abort"

Supporta solo l'evento "abort"

listener

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

dispatchEvent() 

function dispatchEvent()

Restituisce

boolean

getValue(string)

Scopri il valore più recente con la chiave corrispondente nella catena di [nodo corrente] - [nodo padre] -> [nodo padre]>> - ...> - [nodo radice]. Se la chiave non viene trovata, verrà restituita una chiave non definita.

function getValue(key: string)

Parametri

key

string

Restituisce

string | number | boolean | null | undefined

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

Rimuovere il listener eventi "abort", supporta solo l'evento "abort".

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

Parametri

_type

"abort"

Supporta solo l'evento "abort"

listener

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

timeout(number)

Crea una nuova istanza di Aborter con timeout in millisecondi. Impostare il timeout dei parametri su 0 non creerà un timer.

static function timeout(timeout: number)

Parametri

timeout

number

Restituisce

Aborter

withTimeout(number)

Creare e restituire una nuova istanza di Aborter, che verrà aggiunta come nodo figlio dell'interruzione corrente. L'istanza di Aborter corrente diventa nodo padre della nuova istanza. Quando il nodo Aborter corrente o padre attiva l'evento di timeout, anche tutti i nodi figlio interromperanno l'evento. Quando il parametro timeout (in millisecondo) è maggiore di 0, l'evento di interruzione verrà attivato quando timeout. In caso contrario, chiamare il metodo abort() per interrompere manualmente.

function withTimeout(timeout: number)

Parametri

timeout

number

Restituisce

Aborter

Nuova istanza di Aborter creata.

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

Creare e restituire una nuova istanza di Aborter, che verrà aggiunta come nodo figlio dell'interruzione corrente. L'istanza di Aborter corrente diventa nodo padre della nuova istanza. Quando il nodo Aborter corrente o padre attiva l'evento di timeout, anche tutti i nodi figlio interromperanno l'evento. La coppia valore chiave non modificabile verrà impostata nella nuova istanza di Aborter creata. Chiamare getValue() per scoprire il valore più recente con la chiave corrispondente nella catena di [nodo corrente] -> [nodo padre] e [nodo padre]....

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

Parametri

key

string

value

string | number | boolean | null

Restituisce

Aborter