Classe : APIPromise<T>

Une promesse pour le résultat analysé, avec accès à la réponse HTTP.

Les réponses non 2xx sont rejetées avec une APIError, y compris via asResponse().

Étend

Promise<T>

Paramètres de type

T

T

Constructeurs

Constructeur

new APIPromise<T>(responsePromise, parseResponse): APIPromise<T>;

Paramètres

responsePromise

Promise<Response>

parseResponse

(response) => Promise<T>

Valeur de retour

APIPromise<T>

Remplace

Promise<T>.constructor

Méthodes

asResponse()

asResponse(): Promise<Response>;

Se résout vers la Response brute sans analyser le corps. Les requêtes du SDK mettent en mémoire tampon le corps complet sous le délai d’attente de la requête avant le transfert ; sa lecture ensuite appartient à l’appelant. L’appelant possède le corps ; n’utilise pas non plus await sur le résultat analysé avec la même promesse.

Valeur de retour

Promise<Response>

catch()

catch<TResult>(onrejected?): Promise<T | TResult>;

Attache un rappel uniquement pour le rejet de la promesse.

Paramètres de type

TResult

TResult = never

Paramètres

onrejected?

((reason) => TResult | PromiseLike<TResult>) | null

Le rappel à exécuter quand la promesse est rejetée.

Valeur de retour

Promise<T | TResult>

Une promesse pour l’achèvement du rappel.

Remplace

Promise.catch

finally()

finally(onfinally?): Promise<T>;

Attache un rappel invoqué quand la promesse est réglée (tenue ou rejetée). La valeur résolue ne peut pas être modifiée depuis le rappel.

Paramètres

onfinally?

(() => void) | null

Le rappel à exécuter quand la promesse est réglée (tenue ou rejetée).

Valeur de retour

Promise<T>

Une promesse pour l’achèvement du rappel.

Remplace

Promise.finally

map()

map<U>(fn): APIPromise<U>;

Transforme le résultat analysé, en partageant la réponse HTTP et une seule analyse du corps.

Paramètres de type

U

U

Paramètres

fn

(data) => U

Valeur de retour

APIPromise<U>

then()

then<TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>;

Attache des rappels pour la résolution et/ou le rejet de la promesse.

Paramètres de type

TResult1

TResult1 = T

TResult2

TResult2 = never

Paramètres

onfulfilled?

((value) => TResult1 | PromiseLike<TResult1>) | null

Le rappel à exécuter quand la promesse est résolue.

onrejected?

((reason) => TResult2 | PromiseLike<TResult2>) | null

Le rappel à exécuter quand la promesse est rejetée.

Valeur de retour

Promise<TResult1 | TResult2>

Une promesse pour l’achèvement du rappel exécuté.

Remplace

Promise.then

withResponse()

withResponse(): Promise<WithResponse<T>>;

Renvoie le résultat analysé, la réponse HTTP et l’ID de requête.

Valeur de retour

Promise<WithResponse<T>>