Aborter class

Paket:

@azure/storage-queue

Eine Aborterinstanz implementiert die AbortSignal-Schnittstelle, kann HTTP-Anforderungen abbrechen.

• Rufen Sie "Aborter.none" auf, um eine neue Aborter-Instanz ohne Timeout zu erstellen.
• Rufen Sie "Aborter.timeout()" auf, um eine neue Aborter-Instanz mit Timeout zu erstellen.

Für eine vorhandene Instanz wird folgendes abgebrochen:

• Rufen Sie aborter.withTimeout() auf, um eine untergeordnete Aborter-Instanz mit Timeout zu erstellen und zurückzugeben.
• Rufen Sie aborter.withValue(key, value) auf, um eine untergeordnete Aborter-Instanz mit Schlüssel-Wert-Paar zu erstellen und zurückzugeben.
• Rufen Sie aborter.abort() auf, um die aktuelle Instanz und alle untergeordneten Instanzen abzubrechen.
• Rufen Sie "aborter.getValue(key)" auf, um den Wert mit dem entsprechenden Schlüssel vom aktuellen Abbruch für alle übergeordneten Elemente zu suchen und abzurufen.

Eigenschaften

aborted	Status, ob abgebrochen oder nicht.
none	Erstellt eine neue Aborter-Instanz ohne Timeout.
onabort	onabort-Ereignislistener.

Methoden

abort()	Auslösen des Abbruchereignisses sofort wird der Onabort und alle aborten Ereignislistener ausgelöst. Versucht, das Abbruchereignis für alle untergeordneten Aborterknoten auszulösen. Wenn ein Timeout vorhanden ist, wird der Timer abgebrochen. Wenn der Vorgang wahr ist, geschieht nichts.
addEventListener("abort", (this: AbortSignalLike, ev: any) => any)	Neuer "abort"-Ereignislistener hinzugefügt, unterstützt nur das Ereignis "abort".
dispatchEvent()
getValue(string)	Ermitteln Sie den neuesten Wert mit dem entsprechenden Schlüssel in der Kette von [aktuellem Knoten] -> [übergeordneter Knoten] -> [übergeordneter Knoten] -> ... -> [Stammknoten]. Wenn der Schlüssel nicht gefunden wird, wird undefiniert zurückgegeben.
removeEventListener("abort", (this: AbortSignalLike, ev: any) => any)	Entfernen Sie den Ereignislistener "abort", unterstützt nur das Ereignis "abort".
timeout(number)	Erstellt eine neue Aborter-Instanz mit Timeout in Millisekunden. Das Festlegen des Parametertimeouts auf 0 erstellt keinen Timer.
withTimeout(number)	Erstellen und zurückgeben Sie eine neue Aborter-Instanz, die als untergeordneter Knoten des aktuellen Aborter angefügt wird. Die aktuelle Aborter-Instanz wird zum Vaterknoten der neuen Instanz. Wenn der aktuelle oder vater-Knoten timeout-Ereignis auslöst, werden auch alle untergeordneten Knoten ausgelöst. Wenn der Timeoutparameter (in Millisekunden) größer als 0 ist, wird das Abbruchereignis beim Timeout ausgelöst. Rufen Sie andernfalls die Abbruchmethode auf, um manuell abzubrechen.
withValue(string, string | number | boolean | null)	Erstellen und zurückgeben Sie eine neue Aborter-Instanz, die als untergeordneter Knoten des aktuellen Aborter angefügt wird. Die aktuelle Aborter-Instanz wird zum Vaterknoten der neuen Instanz. Wenn der aktuelle oder vater-Knoten timeout-Ereignis auslöst, werden auch alle untergeordneten Knoten ausgelöst. Das unveränderliche Schlüsselwertpaar wird in die neue erstellte Aborter-Instanz festgelegt. Rufen Sie getValue() auf, um den neuesten Wert mit dem entsprechenden Schlüssel in der Kette von [aktuellem Knoten] zu ermitteln –> [übergeordneter Knoten] und [übergeordneter Knoten]....

Details zur Eigenschaft

aborted

Status, ob abgebrochen oder nicht.

aborted: boolean

Eigenschaftswert

boolean

none

Erstellt eine neue Aborter-Instanz ohne Timeout.

static none: Aborter

Eigenschaftswert

Aborter

onabort

onabort-Ereignislistener.

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

Eigenschaftswert

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

Details zur Methode

abort()

Auslösen des Abbruchereignisses sofort wird der Onabort und alle aborten Ereignislistener ausgelöst. Versucht, das Abbruchereignis für alle untergeordneten Aborterknoten auszulösen.

• Wenn ein Timeout vorhanden ist, wird der Timer abgebrochen.
• Wenn der Vorgang wahr ist, geschieht nichts.

function abort()

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

Neuer "abort"-Ereignislistener hinzugefügt, unterstützt nur das Ereignis "abort".

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

Parameter

_type

"abort"

Nur "abort"-Ereignis unterstützen

listener

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

dispatchEvent()

function dispatchEvent()

Gibt zurück

boolean

getValue(string)

Ermitteln Sie den neuesten Wert mit dem entsprechenden Schlüssel in der Kette von [aktuellem Knoten] -> [übergeordneter Knoten] -> [übergeordneter Knoten] -> ... -> [Stammknoten]. Wenn der Schlüssel nicht gefunden wird, wird undefiniert zurückgegeben.

function getValue(key: string)

Parameter

key

string

Gibt zurück

string | number | boolean | null | undefined

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

Entfernen Sie den Ereignislistener "abort", unterstützt nur das Ereignis "abort".

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

Parameter

_type

"abort"

Nur "abort"-Ereignis unterstützen

listener

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

timeout(number)

Erstellt eine neue Aborter-Instanz mit Timeout in Millisekunden. Das Festlegen des Parametertimeouts auf 0 erstellt keinen Timer.

static function timeout(timeout: number)

Parameter

timeout

number

Gibt zurück

Aborter

withTimeout(number)

Erstellen und zurückgeben Sie eine neue Aborter-Instanz, die als untergeordneter Knoten des aktuellen Aborter angefügt wird. Die aktuelle Aborter-Instanz wird zum Vaterknoten der neuen Instanz. Wenn der aktuelle oder vater-Knoten timeout-Ereignis auslöst, werden auch alle untergeordneten Knoten ausgelöst. Wenn der Timeoutparameter (in Millisekunden) größer als 0 ist, wird das Abbruchereignis beim Timeout ausgelöst. Rufen Sie andernfalls die Abbruchmethode auf, um manuell abzubrechen.

function withTimeout(timeout: number)

Parameter

timeout

number

Gibt zurück

Aborter

Die neue Aborter-Instanz wurde erstellt.

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

Erstellen und zurückgeben Sie eine neue Aborter-Instanz, die als untergeordneter Knoten des aktuellen Aborter angefügt wird. Die aktuelle Aborter-Instanz wird zum Vaterknoten der neuen Instanz. Wenn der aktuelle oder vater-Knoten timeout-Ereignis auslöst, werden auch alle untergeordneten Knoten ausgelöst. Das unveränderliche Schlüsselwertpaar wird in die neue erstellte Aborter-Instanz festgelegt. Rufen Sie getValue() auf, um den neuesten Wert mit dem entsprechenden Schlüssel in der Kette von [aktuellem Knoten] zu ermitteln –> [übergeordneter Knoten] und [übergeordneter Knoten]....

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

Parameter

key

string

value

string | number | boolean | null

Gibt zurück

Aborter