Partager via


Aborter class

Un aborter instance implémente l’interface AbortSignal, peut abandonner les requêtes HTTP.

  • Appelez Aborter.none pour créer une nouvelle instance Aborter sans délai d’expiration.
  • Appelez Aborter.timeout() pour créer une nouvelle instance Aborter avec un délai d’expiration.

Pour un abandon de instance existant :

  • Appelez aborter.withTimeout() pour créer et retourner un Aborter enfant instance avec délai d’expiration.
  • Appelez aborter.withValue(key, value) pour créer et retourner un instance Aborter enfant avec une paire clé/valeur.
  • Appelez aborter.abort() pour abandonner les instance actuels et toutes les instances enfants.
  • Appelez aborter.getValue(key) pour rechercher et obtenir la valeur avec la clé correspondante de l’abandon actuel à tous les parents.

Propriétés

aborted

État indiquant s’il a été abandonné ou non.

none

Crée un instance Aborter sans délai d’expiration.

onabort

écouteur d’événements onabort.

Méthodes

abort()

Déclenchez immédiatement l’événement d’abandon, les écouteurs d’événements onabort et tous les abandons seront déclenchés. Tente de déclencher l’événement d’abandon pour tous les nœuds Aborter enfants.

  • S’il existe un délai d’expiration, le minuteur est annulé.
  • Si l’abandon est vrai, rien ne se passera.
addEventListener("abort", (this: AbortSignalLike, ev: any) => any)

Ajout d’un nouvel écouteur d’événement « abandon », qui prend uniquement en charge l’événement « abandon ».

getValue(string)

Découvrez la dernière valeur avec la clé correspondante dans la chaîne de [nœud actuel] -> [nœud parent] -> [nœud grand parent] -> ... -> [nœud racine]. Si la clé est introuvable, undéfined est retourné.

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

Supprimez l’écouteur d’événement « abort » et prenez uniquement en charge l’événement « abort ».

timeout(number)

Crée un instance Aborter avec un délai d’expiration en millisecondes. Définir le délai d’expiration du paramètre sur 0 ne crée pas de minuteur.

withTimeout(number)

Créez et retournez un nouveau instance Aborter, qui sera ajouté en tant que nœud enfant de l’Aborter actuel. Aborter actuel instance devient le nœud parent de la nouvelle instance. Lorsque le nœud Aborter actuel ou parent déclenche un événement de délai d’expiration, l’événement d’abandon de tous les nœuds enfants est également déclenché. Lorsque le paramètre de délai d’expiration (en millisecondes) est supérieur à 0, l’événement d’abandon est déclenché lors du délai d’expiration. Sinon, appelez la méthode abort() pour abandonner manuellement.

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

Créez et retournez un nouveau instance Aborter, qui sera ajouté en tant que nœud enfant de l’Aborter actuel. Aborter actuel instance devient le nœud parent de la nouvelle instance. Lorsque le nœud Aborter actuel ou parent déclenche un événement de délai d’expiration, tous les nœuds enfants abandonnent l’événement sont également déclenchés. La paire valeur de clé immuable est définie dans la nouvelle instance Aborter créée. Appelez getValue() pour connaître la dernière valeur avec la clé correspondante dans la chaîne de [nœud actuel] -> [nœud parent] et [nœud grand parent]....

Détails de la propriété

aborted

État indiquant s’il a été abandonné ou non.

aborted: boolean

Valeur de propriété

boolean

none

Crée un instance Aborter sans délai d’expiration.

static none: Aborter

Valeur de propriété

onabort

écouteur d’événements onabort.

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

Valeur de propriété

(ev?: Event) => any

Détails de la méthode

abort()

Déclenchez immédiatement l’événement d’abandon, les écouteurs d’événements onabort et tous les abandons seront déclenchés. Tente de déclencher l’événement d’abandon pour tous les nœuds Aborter enfants.

  • S’il existe un délai d’expiration, le minuteur est annulé.
  • Si l’abandon est vrai, rien ne se passera.
function abort()

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

Ajout d’un nouvel écouteur d’événement « abandon », qui prend uniquement en charge l’événement « abandon ».

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

Paramètres

_type

"abort"

Prise en charge uniquement de l’événement « abandon »

listener

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

getValue(string)

Découvrez la dernière valeur avec la clé correspondante dans la chaîne de [nœud actuel] -> [nœud parent] -> [nœud grand parent] -> ... -> [nœud racine]. Si la clé est introuvable, undéfined est retourné.

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

Paramètres

key

string

Retours

string | number | boolean | null | undefined

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

Supprimez l’écouteur d’événement « abort » et prenez uniquement en charge l’événement « abort ».

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

Paramètres

_type

"abort"

Prise en charge uniquement de l’événement « abandon »

listener

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

timeout(number)

Crée un instance Aborter avec un délai d’expiration en millisecondes. Définir le délai d’expiration du paramètre sur 0 ne crée pas de minuteur.

static function timeout(timeout: number): Aborter

Paramètres

timeout

number

Retours

withTimeout(number)

Créez et retournez un nouveau instance Aborter, qui sera ajouté en tant que nœud enfant de l’Aborter actuel. Aborter actuel instance devient le nœud parent de la nouvelle instance. Lorsque le nœud Aborter actuel ou parent déclenche un événement de délai d’expiration, l’événement d’abandon de tous les nœuds enfants est également déclenché. Lorsque le paramètre de délai d’expiration (en millisecondes) est supérieur à 0, l’événement d’abandon est déclenché lors du délai d’expiration. Sinon, appelez la méthode abort() pour abandonner manuellement.

function withTimeout(timeout: number): Aborter

Paramètres

timeout

number

Retours

Le nouvel Aborter instance créé.

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

Créez et retournez un nouveau instance Aborter, qui sera ajouté en tant que nœud enfant de l’Aborter actuel. Aborter actuel instance devient le nœud parent de la nouvelle instance. Lorsque le nœud Aborter actuel ou parent déclenche un événement de délai d’expiration, tous les nœuds enfants abandonnent l’événement sont également déclenchés. La paire valeur de clé immuable est définie dans la nouvelle instance Aborter créée. Appelez getValue() pour connaître la dernière valeur avec la clé correspondante dans la chaîne de [nœud actuel] -> [nœud parent] et [nœud grand parent]....

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

Paramètres

key

string

value

string | number | boolean | null

Retours