ДокументацияJS SDK: Классы (Classes)Class: APIPromise<T>

Class: APIPromise<T>

A promise for the parsed result with access to the HTTP response.

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

Наследует

  • Promise<T>

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

T

T

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

Конструктор

TS THEME={NULL} api.wedstack.ru/v1
new APIPromise<T>(responsePromise, parseResponse): APIPromise<T>;

Параметры

responsePromise

Promise<Response>

parseResponse

(response) => Promise<T>

Возвращаемое значение

APIPromise<T>

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

TS THEME={NULL} api.wedstack.ru/v1
Promise<T>.constructor

Методы

asResponse()

TS THEME={NULL} api.wedstack.ru/v1
asResponse(): Promise<Response>;

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

Возвращаемое значение

Promise<Response>


catch()

TS THEME={NULL} api.wedstack.ru/v1
catch<TResult>(onrejected?): Promise<T | TResult>;

Attaches a callback for only the rejection of the Promise.

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

TResult

TResult = never

Параметры

onrejected?

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

Коллбек, выполняемый при отклонении промиса.

Возвращаемое значение

Promise<T | TResult>

A Promise for the completion of the callback.

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

TS THEME={NULL} api.wedstack.ru/v1
Promise.catch

finally()

TS THEME={NULL} api.wedstack.ru/v1
finally(onfinally?): Promise<T>;

Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
разрешенное значение не может быть изменено из этого коллбека.

Параметры

onfinally?

(() => void) | null

Коллбек, выполняемый при завершении промиса (успешном или с ошибкой).

Возвращаемое значение

Promise<T>

A Promise for the completion of the callback.

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

TS THEME={NULL} api.wedstack.ru/v1
Promise.finally

map()

TS THEME={NULL} api.wedstack.ru/v1
map<U>(fn): APIPromise<U>;

Трансформировать распарсенный результат с общим HTTP-ответом и однократным парсингом тела.

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

U

U

Параметры

fn

(data) => U

Возвращаемое значение

APIPromise<U>


then()

TS THEME={NULL} api.wedstack.ru/v1
then<TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>;

Attaches callbacks for the resolution and/or rejection of the Promise.

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

TResult1

TResult1 = T

TResult2

TResult2 = never

Параметры

onfulfilled?

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

Коллбек, выполняемый при успешном разрешении промиса.

onrejected?

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

Коллбек, выполняемый при отклонении промиса.

Возвращаемое значение

Promise<TResult1 | TResult2>

A Promise for the completion of which ever callback is executed.

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

TS THEME={NULL} api.wedstack.ru/v1
Promise.then

withResponse()

TS THEME={NULL} api.wedstack.ru/v1
withResponse(): Promise<WithResponse<T>>;

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

Возвращаемое значение

Promise<WithResponse<T>>