Aborter class

Pakiet:: @azure/storage-queue

Wystąpienie aborter implementuje interfejs AbortSignal, może przerwać żądania HTTP.

Wywołaj metodę Aborter.none, aby utworzyć nowe wystąpienie Aborter bez przekroczenia limitu czasu.
Wywołaj metodę Aborter.timeout(), aby utworzyć nowe wystąpienie Aborter z przekroczeniem limitu czasu.

W przypadku istniejącego przerwania wystąpienia:

Wywołaj metodę aborter.withTimeout(), aby utworzyć i zwrócić podrzędne wystąpienie Aborter z przekroczeniem limitu czasu.
Wywołaj metodę aborter.withValue(klucz, wartość), aby utworzyć i zwrócić podrzędne wystąpienie aborter z parą klucz/wartość.
Wywołaj metodę aborter.abort(), aby przerwać bieżące wystąpienie i wszystkie wystąpienia podrzędne.
Wywołaj metodę aborter.getValue(key), aby wyszukać i pobrać wartość z odpowiedniego klucza z bieżącego elementu aborter do wszystkich elementów nadrzędnych.

Właściwości

aborted	Stan niezależnie od tego, czy przerwano, czy nie.
none	Tworzy nowe wystąpienie Aborter bez limitu czasu.
onabort	odbiornik zdarzeń onabort.

Metody

abort()	Zdarzenie przerwania wyzwalacza natychmiast, zostanie wyzwolony odbiornik zdarzeń onabort i wszystkie odbiorniki zdarzeń przerwania. Spróbuje wyzwolić zdarzenie przerwania dla wszystkich węzłów podrzędnych Aborter. W przypadku przekroczenia limitu czasu czasomierz zostanie anulowany. Jeśli przerwane jest prawdziwe, nic się nie stanie.
addEventListener("abort", (this: AbortSignalLike, ev: any) => any)	Dodano nowy odbiornik zdarzeń "abort" i obsługuje tylko zdarzenie "abort".
dispatchEvent()
getValue(string)	Znajdź najnowszą wartość z odpowiednim kluczem w łańcuchu [bieżącego węzła] —> [węzeł nadrzędny] —> [węzeł główny] —> ... —> [węzeł główny]. Jeśli klucz nie zostanie znaleziony, zostanie zwrócony niezdefiniowany.
removeEventListener("abort", (this: AbortSignalLike, ev: any) => any)	Usuń odbiornik zdarzeń "abort", obsługują tylko zdarzenie "abort".
timeout(number)	Tworzy nowe wystąpienie Aborter z limitem czasu w milisekundach. Ustawienie limitu czasu parametru na wartość 0 nie spowoduje utworzenia czasomierza.
withTimeout(number)	Utwórz i zwróć nowe wystąpienie Aborter, które zostanie dołączone jako węzeł podrzędny bieżącego abortera. Bieżące wystąpienie Aborter staje się węzłem ojca nowego wystąpienia. Gdy bieżący węzeł aborter lub ojciec wyzwala zdarzenie przekroczenia limitu czasu, wszystkie węzły podrzędne również zostaną wyzwolone. Gdy parametr limitu czasu (w milisekundach) jest większy niż 0, zdarzenie przerwania zostanie wyzwolone po przekroczeniu limitu czasu. W przeciwnym razie wywołaj metodę abort(), aby ręcznie przerwać.
withValue(string, string \| number \| boolean \| null)	Utwórz i zwróć nowe wystąpienie Aborter, które zostanie dołączone jako węzeł podrzędny bieżącego abortera. Bieżące wystąpienie Aborter staje się węzłem ojca nowego wystąpienia. Gdy bieżący węzeł aborter lub ojciec wyzwala zdarzenie przekroczenia limitu czasu, wszystkie węzły podrzędne również zostaną wyzwolone. Niezmienna para wartości klucza zostanie ustawiona na nowo utworzone wystąpienie Aborter. Wywołaj metodę getValue(), aby dowiedzieć się, jak uzyskać najnowszą wartość z odpowiednim kluczem w łańcuchu [bieżącego węzła] —> [węzeł nadrzędny] i [węzeł nadrzędny]....

Szczegóły właściwości

aborted

Stan niezależnie od tego, czy przerwano, czy nie.

aborted: boolean

Wartość właściwości

boolean

none

Tworzy nowe wystąpienie Aborter bez limitu czasu.

static none: Aborter

Wartość właściwości

Aborter

onabort

odbiornik zdarzeń onabort.

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

Wartość właściwości

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

Szczegóły metody

abort()

Zdarzenie przerwania wyzwalacza natychmiast, zostanie wyzwolony odbiornik zdarzeń onabort i wszystkie odbiorniki zdarzeń przerwania. Spróbuje wyzwolić zdarzenie przerwania dla wszystkich węzłów podrzędnych Aborter.

W przypadku przekroczenia limitu czasu czasomierz zostanie anulowany.
Jeśli przerwane jest prawdziwe, nic się nie stanie.

function abort()

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

Dodano nowy odbiornik zdarzeń "abort" i obsługuje tylko zdarzenie "abort".

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

Parametry

_type: "abort"

Obsługa tylko zdarzenia "przerwania"

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

dispatchEvent()

function dispatchEvent()

Zwraca

boolean

getValue(string)

Znajdź najnowszą wartość z odpowiednim kluczem w łańcuchu [bieżącego węzła] —> [węzeł nadrzędny] —> [węzeł główny] —> ... —> [węzeł główny]. Jeśli klucz nie zostanie znaleziony, zostanie zwrócony niezdefiniowany.

function getValue(key: string)

Parametry

key: string

Zwraca

string | number | boolean | null | undefined

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

Usuń odbiornik zdarzeń "abort", obsługują tylko zdarzenie "abort".

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

Parametry

_type: "abort"

Obsługa tylko zdarzenia "przerwania"

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

timeout(number)

Tworzy nowe wystąpienie Aborter z limitem czasu w milisekundach. Ustawienie limitu czasu parametru na wartość 0 nie spowoduje utworzenia czasomierza.

static function timeout(timeout: number)

Parametry

timeout: number

Zwraca

Aborter

withTimeout(number)

Utwórz i zwróć nowe wystąpienie Aborter, które zostanie dołączone jako węzeł podrzędny bieżącego abortera. Bieżące wystąpienie Aborter staje się węzłem ojca nowego wystąpienia. Gdy bieżący węzeł aborter lub ojciec wyzwala zdarzenie przekroczenia limitu czasu, wszystkie węzły podrzędne również zostaną wyzwolone. Gdy parametr limitu czasu (w milisekundach) jest większy niż 0, zdarzenie przerwania zostanie wyzwolone po przekroczeniu limitu czasu. W przeciwnym razie wywołaj metodę abort(), aby ręcznie przerwać.

function withTimeout(timeout: number)

Parametry

timeout: number

Zwraca

Aborter

Utworzone nowe wystąpienie Aborter.

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

Utwórz i zwróć nowe wystąpienie Aborter, które zostanie dołączone jako węzeł podrzędny bieżącego abortera. Bieżące wystąpienie Aborter staje się węzłem ojca nowego wystąpienia. Gdy bieżący węzeł aborter lub ojciec wyzwala zdarzenie przekroczenia limitu czasu, wszystkie węzły podrzędne również zostaną wyzwolone. Niezmienna para wartości klucza zostanie ustawiona na nowo utworzone wystąpienie Aborter. Wywołaj metodę getValue(), aby dowiedzieć się, jak uzyskać najnowszą wartość z odpowiednim kluczem w łańcuchu [bieżącego węzła] —> [węzeł nadrzędny] i [węzeł nadrzędny]....

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

Parametry

key: string

value: string | number | boolean | null

Zwraca

Aborter

Opinia

Czy ta strona była pomocna?