Aborter class

Balíček:
@azure/storage-queue

Instance aborter implementuje rozhraní AbortSignal, může přerušit požadavky HTTP.

  • VoláníM metody Aborter.none vytvořte novou instanci Aborter bez časového limitu.
  • Zavolejte Aborter.timeout() a vytvořte novou instanci Aborter s vypršením časového limitu.

Pro existující instanci přerušte:

  • Voláním metody aborter.withTimeout() vytvořte a vraťte podřízenou instanci Aborter s vypršením časového limitu.
  • Volání aborter.withValue(key, value) k vytvoření a vrácení podřízené instance Aborter s párem klíč/hodnota.
  • Voláním metody aborter.abort() přerušíte aktuální instanci a všechny podřízené instance.
  • Volání aborter.getValue(key) pro vyhledávání a získání hodnoty s odpovídajícím klíčem od aktuálního přerušení do všech nadřazených objektů.

Vlastnosti

aborted

Stav přerušení nebo ne.
none

Vytvoří novou instanci Aborter bez časového limitu.
onabort

posluchač události onobort.

Metody

abort()

Okamžitě aktivujte událost přerušení, aktivují se naslouchací procesy událostí onabort a všechny naslouchací procesy událostí. Pokusí se aktivovat událost přerušení pro všechny podřízené uzly Aborter.

  • Pokud dojde k vypršení časového limitu, časovač se zruší.
  • Pokud je přerušeno, nic se nestane.
addEventListener("abort", (this: AbortSignalLike, ev: any) => any)

Přidání nového naslouchacího procesu událostí "abort" podporuje pouze událost "abort".
dispatchEvent()
getValue(string)

Zjistěte nejnovější hodnotu s odpovídajícím klíčem v řetězci [aktuálního uzlu] –> [nadřazený uzel] –> [nadřazený uzel] –> ... –> [kořenový uzel]. Pokud se klíč nenajde, vrátí se nedefinovaný klíč.
removeEventListener("abort", (this: AbortSignalLike, ev: any) => any)

Odeberte naslouchací proces události "abort", podporuje pouze událost přerušení.
timeout(number)

Vytvoří novou instanci Aborter s časovým limitem v milisekundách. Časový limit parametru na hodnotu 0 nevytvoří časovač.
withTimeout(number)

Vytvořte a vraťte novou instanci Aborter, která se připojí jako podřízený uzel aktuálního Aborteru. Aktuální instance Aborter se stane uzlem otce nové instance. Když aktuální uzel nebo uzel Aborter aktivuje událost časového limitu, aktivuje se také událost přerušení všech podřízených uzlů. Pokud je parametr časového limitu (v milisekundách) větší než 0, událost přerušení se aktivuje při vypršení časového limitu. V opačném případě zavolejte metodu abort() pro ruční přerušení.
withValue(string, string | number | boolean | null)

Vytvořte a vraťte novou instanci Aborter, která se připojí jako podřízený uzel aktuálního Aborteru. Aktuální instance Aborter se stane uzlem otce nové instance. Když aktuální uzel nebo uzel Aborter aktivuje událost časového limitu, aktivuje se také událost přerušení všech podřízených uzlů. Pár neměnných hodnot klíče se nastaví na novou vytvořenou instanci Aborter. Volání metody getValue() pro zjištění nejnovější hodnoty s odpovídajícím klíčem v řetězci [aktuálního uzlu] –> [nadřazený uzel] a [nadřazený uzel]....

Podrobnosti vlastnosti

aborted

Stav přerušení nebo ne.

aborted: boolean

Hodnota vlastnosti

boolean

none

Vytvoří novou instanci Aborter bez časového limitu.

static none: Aborter

Hodnota vlastnosti

Aborter

onabort

posluchač události onobort.

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

Hodnota vlastnosti

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

Podrobnosti metody

abort()

Okamžitě aktivujte událost přerušení, aktivují se naslouchací procesy událostí onabort a všechny naslouchací procesy událostí. Pokusí se aktivovat událost přerušení pro všechny podřízené uzly Aborter.

  • Pokud dojde k vypršení časového limitu, časovač se zruší.
  • Pokud je přerušeno, nic se nestane.
function abort()

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

Přidání nového naslouchacího procesu událostí "abort" podporuje pouze událost "abort".

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

Parametry

_type

"abort"

Podpora pouze události "abort"

listener

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

dispatchEvent() 

function dispatchEvent()

Návraty

boolean

getValue(string)

Zjistěte nejnovější hodnotu s odpovídajícím klíčem v řetězci [aktuálního uzlu] –> [nadřazený uzel] –> [nadřazený uzel] –> ... –> [kořenový uzel]. Pokud se klíč nenajde, vrátí se nedefinovaný klíč.

function getValue(key: string)

Parametry

key

string

Návraty

string | number | boolean | null | undefined

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

Odeberte naslouchací proces události "abort", podporuje pouze událost přerušení.

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

Parametry

_type

"abort"

Podpora pouze události "abort"

listener

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

timeout(number)

Vytvoří novou instanci Aborter s časovým limitem v milisekundách. Časový limit parametru na hodnotu 0 nevytvoří časovač.

static function timeout(timeout: number)

Parametry

timeout

number

Návraty

Aborter

withTimeout(number)

Vytvořte a vraťte novou instanci Aborter, která se připojí jako podřízený uzel aktuálního Aborteru. Aktuální instance Aborter se stane uzlem otce nové instance. Když aktuální uzel nebo uzel Aborter aktivuje událost časového limitu, aktivuje se také událost přerušení všech podřízených uzlů. Pokud je parametr časového limitu (v milisekundách) větší než 0, událost přerušení se aktivuje při vypršení časového limitu. V opačném případě zavolejte metodu abort() pro ruční přerušení.

function withTimeout(timeout: number)

Parametry

timeout

number

Návraty

Aborter

Nová instance Aborter byla vytvořena.

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

Vytvořte a vraťte novou instanci Aborter, která se připojí jako podřízený uzel aktuálního Aborteru. Aktuální instance Aborter se stane uzlem otce nové instance. Když aktuální uzel nebo uzel Aborter aktivuje událost časového limitu, aktivuje se také událost přerušení všech podřízených uzlů. Pár neměnných hodnot klíče se nastaví na novou vytvořenou instanci Aborter. Volání metody getValue() pro zjištění nejnovější hodnoty s odpovídajícím klíčem v řetězci [aktuálního uzlu] –> [nadřazený uzel] a [nadřazený uzel]....

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

Parametry

key

string

value

string | number | boolean | null

Návraty

Aborter