Classe: APIPromise<T>

Uma promise para o resultado analisado, com acesso à resposta HTTP.

As respostas não-2xx são rejeitadas com um APIError, inclusive através de asResponse().

Estende

• Promise<T>

Parâmetros de tipo

T

T

Construtores

Construtor

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

Parâmetros

responsePromise

Promise<Response>

parseResponse

(response) => Promise<T>

Devolve

APIPromise<T>

Substitui

Promise<T>.constructor

Métodos

asResponse()

asResponse(): Promise<Response>;

Resolve para a Response em bruto sem analisar o corpo. Os pedidos do SDK guardam em buffer o corpo completo dentro do tempo limite do pedido antes da transferência; a leitura posterior pertence ao chamador. O corpo pertence ao chamador; não faças também await ao resultado analisado na mesma promise.

Devolve

Promise<Response>

catch()

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

Anexa um callback apenas para a rejeição da Promise.

Parâmetros de tipo

TResult

TResult = never

Parâmetros

onrejected?

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

O callback a executar quando a Promise é rejeitada.

Devolve

Promise<T | TResult>

Uma Promise para a conclusão do callback.

Substitui

Promise.catch

finally()

finally(onfinally?): Promise<T>;

Anexa um callback que é invocado quando a Promise termina (cumprida ou rejeitada). O valor resolvido não pode ser modificado a partir do callback.

Parâmetros

onfinally?

(() => void) | null

O callback a executar quando a Promise termina (cumprida ou rejeitada).

Devolve

Promise<T>

Uma Promise para a conclusão do callback.

Substitui

Promise.finally

map()

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

Transforma o resultado analisado, partilhando a resposta HTTP e uma única análise do corpo.

Parâmetros de tipo

U

U

Parâmetros

fn

(data) => U

Devolve

APIPromise<U>

then()

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

Anexa callbacks para a resolução e/ou rejeição da Promise.

Parâmetros de tipo

TResult1

TResult1 = T

TResult2

TResult2 = never

Parâmetros

onfulfilled?

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

O callback a executar quando a Promise é resolvida.

onrejected?

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

O callback a executar quando a Promise é rejeitada.

Devolve

Promise<TResult1 | TResult2>

Uma Promise para a conclusão do callback que for executado.

Substitui

Promise.then

withResponse()

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

Devolve o resultado analisado, a resposta HTTP e o ID do pedido.

Devolve

Promise<WithResponse<T>>