Clase: APIPromise<T>

Una promesa del resultado analizado, con acceso a la respuesta HTTP.

Las respuestas que no son 2xx se rechazan con un APIError, incluso a través de asResponse().

Extiende

• Promise<T>

Parámetros de tipo

T

T

Constructores

Constructor

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

Parámetros

responsePromise

Promise<Response>

parseResponse

(response) => Promise<T>

Devuelve

APIPromise<T>

Sobrescribe

Promise<T>.constructor

Métodos

asResponse()

asResponse(): Promise<Response>;

Se resuelve con la Response sin procesar, sin analizar el cuerpo. Las solicitudes del SDK almacenan en búfer todo el cuerpo dentro del tiempo de espera de la solicitud antes de cederlo; leerlo después es responsabilidad de quien llama. El cuerpo es de quien llama; no hagas también await del resultado analizado en la misma promesa.

Devuelve

Promise<Response>

catch()

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

Adjunta una devolución de llamada solo para el rechazo de la promesa.

Parámetros de tipo

TResult

TResult = never

Parámetros

onrejected?

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

La devolución de llamada que se ejecuta cuando se rechaza la promesa.

Devuelve

Promise<T | TResult>

Una promesa de la finalización de la devolución de llamada.

Sobrescribe

Promise.catch

finally()

finally(onfinally?): Promise<T>;

Adjunta una devolución de llamada que se invoca cuando la promesa se resuelve (ya sea cumplida o rechazada). El valor resuelto no se puede modificar desde la devolución de llamada.

Parámetros

onfinally?

(() => void) | null

La devolución de llamada que se ejecuta cuando la promesa se resuelve (ya sea cumplida o rechazada).

Devuelve

Promise<T>

Una promesa de la finalización de la devolución de llamada.

Sobrescribe

Promise.finally

map()

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

Transforma el resultado analizado, compartiendo la respuesta HTTP y un único análisis del cuerpo.

Parámetros de tipo

U

U

Parámetros

fn

(data) => U

Devuelve

APIPromise<U>

then()

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

Adjunta devoluciones de llamada para la resolución o el rechazo de la promesa.

Parámetros de tipo

TResult1

TResult1 = T

TResult2

TResult2 = never

Parámetros

onfulfilled?

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

La devolución de llamada que se ejecuta cuando se resuelve la promesa.

onrejected?

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

La devolución de llamada que se ejecuta cuando se rechaza la promesa.

Devuelve

Promise<TResult1 | TResult2>

Una promesa de la finalización de la devolución de llamada que se ejecute.

Sobrescribe

Promise.then

withResponse()

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

Devuelve el resultado analizado, la respuesta HTTP y el ID de la solicitud.

Devuelve

Promise<WithResponse<T>>