Klasse: APIPromise<T>

Ein Promise für das geparste Ergebnis mit Zugriff auf die HTTP-Antwort.

Nicht-2xx-Antworten werden mit einem APIError abgelehnt, auch über asResponse().

Erweitert

Promise<T>

Typparameter

T

T

Konstruktoren

Konstruktor

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

Parameter

responsePromise

Promise<Response>

parseResponse

(response) => Promise<T>

Rückgabewert

APIPromise<T>

Überschreibt

Promise<T>.constructor

Methoden

asResponse()

asResponse(): Promise<Response>;

Löst zur rohen Response auf, ohne den Body zu parsen. SDK-Anfragen puffern den vollständigen Body bis zum Übergang innerhalb des Anfrage-Zeitlimits; das anschließende Lesen liegt beim Aufrufer. Der Aufrufer besitzt den Body; warte nicht zusätzlich mit await auf das geparste Ergebnis desselben Promise.

Rückgabewert

Promise<Response>

catch()

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

Hängt einen Callback nur für die Ablehnung des Promise an.

Typparameter

TResult

TResult = never

Parameter

onrejected?

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

Der Callback, der ausgeführt wird, wenn das Promise abgelehnt wird.

Rückgabewert

Promise<T | TResult>

Ein Promise für den Abschluss des Callbacks.

Überschreibt

Promise.catch

finally()

finally(onfinally?): Promise<T>;

Hängt einen Callback an, der aufgerufen wird, wenn das Promise abgeschlossen ist (erfüllt oder abgelehnt). Der aufgelöste Wert kann vom Callback nicht geändert werden.

Parameter

onfinally?

(() => void) | null

Der Callback, der ausgeführt wird, wenn das Promise abgeschlossen ist (erfüllt oder abgelehnt).

Rückgabewert

Promise<T>

Ein Promise für den Abschluss des Callbacks.

Überschreibt

Promise.finally

map()

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

Transformiert das geparste Ergebnis und teilt dabei die HTTP-Antwort und ein einmaliges Body-Parsen.

Typparameter

U

U

Parameter

fn

(data) => U

Rückgabewert

APIPromise<U>

then()

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

Hängt Callbacks für die Auflösung und/oder Ablehnung des Promise an.

Typparameter

TResult1

TResult1 = T

TResult2

TResult2 = never

Parameter

onfulfilled?

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

Der Callback, der ausgeführt wird, wenn das Promise aufgelöst wird.

onrejected?

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

Der Callback, der ausgeführt wird, wenn das Promise abgelehnt wird.

Rückgabewert

Promise<TResult1 | TResult2>

Ein Promise für den Abschluss des jeweils ausgeführten Callbacks.

Überschreibt

Promise.then

withResponse()

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

Gibt das geparste Ergebnis, die HTTP-Antwort und die Request-ID zurück.

Rückgabewert

Promise<WithResponse<T>>