Класс: APIPromise<T>

Промис для разобранного результата с доступом к HTTP-ответу.

Ответы с кодом не 2xx отклоняются с APIError, в том числе через asResponse().

Расширяет

• Promise<T>

Параметры типа

T

T

Конструкторы

Конструктор

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

Параметры

responsePromise

Promise<Response>

parseResponse

(response) => Promise<T>

Возвращает

APIPromise<T>

Переопределяет

Promise<T>.constructor

Методы

asResponse()

asResponse(): Promise<Response>;

Возвращает исходный Response без разбора тела. Запросы SDK помещают всё тело в буфер в пределах тайм-аута запроса до передачи; дальнейшее чтение — на стороне вызывающего кода. Тело принадлежит вызывающему коду; не делайте также await разобранного результата на том же промисе.

Возвращает

Promise<Response>

catch()

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

Прикрепляет функцию обратного вызова только для отклонения промиса.

Параметры типа

TResult

TResult = never

Параметры

onrejected?

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

Функция обратного вызова, выполняемая при отклонении промиса.

Возвращает

Promise<T | TResult>

Промис завершения функции обратного вызова.

Переопределяет

Promise.catch

finally()

finally(onfinally?): Promise<T>;

Прикрепляет функцию обратного вызова, которая вызывается, когда промис завершается (успешно или с ошибкой). Разрешённое значение нельзя изменить из этой функции.

Параметры

onfinally?

(() => void) | null

Функция обратного вызова, выполняемая, когда промис завершается (успешно или с ошибкой).

Возвращает

Promise<T>

Промис завершения функции обратного вызова.

Переопределяет

Promise.finally

map()

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

Преобразует разобранный результат, разделяя HTTP-ответ и единственный разбор тела.

Параметры типа

U

U

Параметры

fn

(data) => U

Возвращает

APIPromise<U>

then()

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

Прикрепляет функции обратного вызова для успешного завершения и/или отклонения промиса.

Параметры типа

TResult1

TResult1 = T

TResult2

TResult2 = never

Параметры

onfulfilled?

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

Функция обратного вызова, выполняемая при успешном завершении промиса.

onrejected?

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

Функция обратного вызова, выполняемая при отклонении промиса.

Возвращает

Promise<TResult1 | TResult2>

Промис завершения той функции обратного вызова, которая будет выполнена.

Переопределяет

Promise.then

withResponse()

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

Возвращает разобранный результат, HTTP-ответ и ID запроса.

Возвращает

Promise<WithResponse<T>>