문서

클래스: APIPromise<T>

파싱된 결과에 대한 promise이며 HTTP 응답에도 접근할 수 있습니다.

2xx가 아닌 응답은 asResponse()를 통한 경우를 포함해 APIError로 거부됩니다.

상속

  • 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의 거부에 대해서만 콜백을 연결합니다.

타입 매개변수

TResult

TResult = never

매개변수

onrejected?

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

Promise가 거부될 때 실행할 콜백입니다.

반환값

Promise<T | TResult>

콜백 완료에 대한 Promise입니다.

재정의

Promise.catch

finally()

finally(onfinally?): Promise<T>;

Promise가 확정(이행 또는 거부)될 때 호출되는 콜백을 연결합니다. 해석된 값은 콜백에서 수정할 수 없습니다.

매개변수

onfinally?

(() => void) | null

Promise가 확정(이행 또는 거부)될 때 실행할 콜백입니다.

반환값

Promise<T>

콜백 완료에 대한 Promise입니다.

재정의

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>;

Promise의 이행 및/또는 거부에 대한 콜백을 연결합니다.

타입 매개변수

TResult1

TResult1 = T

TResult2

TResult2 = never

매개변수

onfulfilled?

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

Promise가 이행될 때 실행할 콜백입니다.

onrejected?

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

Promise가 거부될 때 실행할 콜백입니다.

반환값

Promise<TResult1 | TResult2>

실행된 콜백의 완료에 대한 Promise입니다.

재정의

Promise.then

withResponse()

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

파싱된 결과, HTTP 응답, 요청 ID를 반환합니다.

반환값

Promise<WithResponse<T>>