Classe: APIPromise<T>

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

Respostas que não são 2xx são rejeitadas com um APIError, inclusive por meio 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>

Retorno

APIPromise<T>

Sobrescreve

Promise<T>.constructor

Métodos

asResponse()

asResponse(): Promise<Response>;

Resolve para o Response bruto sem analisar o corpo. As requisições do SDK armazenam em buffer o corpo inteiro dentro do tempo limite da requisição antes da entrega; lê-lo depois fica a cargo de quem chamou. O chamador é dono do corpo; não faça também await no resultado analisado na mesma promise.

Retorno

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.

Retorno

Promise<T | TResult>

Uma Promise para a conclusão do callback.

Sobrescreve

Promise.catch

finally()

finally(onfinally?): Promise<T>;

Anexa um callback invocado quando a Promise é resolvida (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 é resolvida (cumprida ou rejeitada).

Retorno

Promise<T>

Uma Promise para a conclusão do callback.

Sobrescreve

Promise.finally

map()

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

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

Parâmetros de tipo

U

U

Parâmetros

fn

(data) => U

Retorno

APIPromise<U>

then()

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

Anexa callbacks para a resolução e/ou a 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.

Retorno

Promise<TResult1 | TResult2>

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

Sobrescreve

Promise.then

withResponse()

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

Retorna o resultado analisado, a resposta HTTP e o ID da requisição.

Retorno

Promise<WithResponse<T>>