クラス：APIPromise<T>

HTTP 応答にアクセスできる、パース済み結果の promise。

非 2xx の応答は APIError で reject します。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 のリクエストは、引き渡し前にリクエストのタイムアウトの範囲で本文全体をバッファリングします。その後本文を読むのは呼び出し側の責任です。本文の所有権は呼び出し側にあり、同じ promise でパース済みの結果を await しないでください。

戻り値

Promise<Response>

catch()

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

Promise の reject だけに対してコールバックを登録します。

型パラメーター

TResult

TResult = never

パラメーター

onrejected?

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

Promise が reject されたときに実行するコールバック。

戻り値

Promise<T | TResult>

コールバックの完了を表す Promise。

オーバーライド

Promise.catch

finally()

finally(onfinally?): Promise<T>;

Promise が確定したとき（fulfilled または rejected）に呼ばれるコールバックを登録します。解決済みの値はコールバックから変更できません。

パラメーター

onfinally?

(() => void) | null

Promise が確定したとき（fulfilled または rejected）に実行するコールバック。

戻り値

Promise<T>

コールバックの完了を表す Promise。

オーバーライド

Promise.finally

map()

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

パース済みの結果を変換します。HTTP 応答と 1 回の本文パースを共有します。

型パラメーター

U

U

パラメーター

fn

(data) => U

戻り値

APIPromise<U>

then()

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

Promise の解決または reject に対してコールバックを登録します。

型パラメーター

TResult1

TResult1 = T

TResult2

TResult2 = never

パラメーター

onfulfilled?

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

Promise が解決されたときに実行するコールバック。

onrejected?

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

Promise が reject されたときに実行するコールバック。

戻り値

Promise<TResult1 | TResult2>

実行されたコールバックの完了を表す Promise。

オーバーライド

Promise.then

withResponse()

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

パース済みの結果、HTTP 応答、リクエスト ID を返します。

戻り値

Promise<WithResponse<T>>