WebResource class
새 WebResource 개체를 만듭니다.
이 클래스는 라이브러리/구현에 구애받지 않고 요청을 시작하는 데 필요한 속성을 래핑하여 REST 호출에 대한 추상화를 제공합니다.
생성자
속성
| abort |
|
| agent |
|
| body | |
| form |
|
| headers | |
| keep |
|
| method | |
| on |
다운로드 진행 시 발생하는 콜백입니다. |
| on |
업로드 진행 시 발생하는 콜백입니다. |
| operation |
지정된 OperationSpec 및 HttpOperationResponse 조합에 대한 적절한 OperationResponse를 반환하는 함수입니다. 정의되지 않은 경우 간단한 상태 코드 조회가 사용됩니다. |
| operation |
|
| proxy |
|
| query | |
| redirect |
|
| should |
HttpOperationResponse를 역직렬화해야 하는지 여부입니다. 정의되지 않은 경우 HttpOperationResponse를 역직렬화해야 합니다. |
| stream |
HttpOperationResponse의 본문을 스트림으로 처리해야 하는지 여부입니다. |
| timeout | |
| url | |
| with |
메서드
| clone() | 이 WebResource HTTP 요청 개체를 복제합니다. |
| prepare(Request |
요청을 준비합니다. |
| validate |
메서드, URL, 헤더["Content-Type"], headers["accept-language"]와 같은 필수 속성이 정의되어 있는지 확인합니다. 위에서 언급한 속성 중 하나가 정의되지 않은 경우 오류가 발생합니다. |
생성자 세부 정보
WebResource(string, HttpMethods, any, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, AgentSettings, number)
new WebResource(url?: string, method?: HttpMethods, body?: any, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, agentSettings?: AgentSettings, redirectLimit?: number)매개 변수
- url
-
string
- method
- HttpMethods
- body
-
any
- query
-
{[key: string]: any}
- headers
-
{[key: string]: any} | HttpHeadersLike
- streamResponseBody
-
boolean
- withCredentials
-
boolean
- abortSignal
- AbortSignalLike
- timeout
-
number
- onUploadProgress
-
(progress: TransferProgressEvent) => void
- onDownloadProgress
-
(progress: TransferProgressEvent) => void
- proxySettings
- ProxySettings
- keepAlive
-
boolean
- agentSettings
- AgentSettings
- redirectLimit
-
number
속성 세부 정보
abortSignal
agentSettings
body
body?: any속성 값
any
formData
formData?: any속성 값
any
headers
keepAlive
keepAlive?: boolean속성 값
boolean
method
onDownloadProgress
다운로드 진행 시 발생하는 콜백입니다.
onDownloadProgress?: (progress: TransferProgressEvent) => void속성 값
(progress: TransferProgressEvent) => void
onUploadProgress
업로드 진행 시 발생하는 콜백입니다.
onUploadProgress?: (progress: TransferProgressEvent) => void속성 값
(progress: TransferProgressEvent) => void
operationResponseGetter
지정된 OperationSpec 및 HttpOperationResponse 조합에 대한 적절한 OperationResponse를 반환하는 함수입니다. 정의되지 않은 경우 간단한 상태 코드 조회가 사용됩니다.
operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse속성 값
(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse
operationSpec
proxySettings
query
query?: {[key: string]: any}속성 값
{[key: string]: any}
redirectLimit
redirectLimit?: number속성 값
number
shouldDeserialize
HttpOperationResponse를 역직렬화해야 하는지 여부입니다. 정의되지 않은 경우 HttpOperationResponse를 역직렬화해야 합니다.
shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean속성 값
boolean | (response: HttpOperationResponse) => boolean
streamResponseBody
HttpOperationResponse의 본문을 스트림으로 처리해야 하는지 여부입니다.
streamResponseBody?: boolean속성 값
boolean
timeout
timeout: number속성 값
number
url
url: string속성 값
string
withCredentials
withCredentials: boolean속성 값
boolean
메서드 세부 정보
clone()
이 WebResource HTTP 요청 개체를 복제합니다.
function clone(): WebResource반환
이 WebResource HTTP 요청 개체의 복제본입니다.
prepare(RequestPrepareOptions)
요청을 준비합니다.
function prepare(options: RequestPrepareOptions): WebResource매개 변수
- options
- RequestPrepareOptions
요청을 준비하기 위해 제공하는 옵션입니다.
반환
요청 파이프라인에 제공해야 하는 준비된 WebResource(HTTP 요청) 개체를 반환합니다.
validateRequestProperties()
메서드, URL, 헤더["Content-Type"], headers["accept-language"]와 같은 필수 속성이 정의되어 있는지 확인합니다. 위에서 언급한 속성 중 하나가 정의되지 않은 경우 오류가 발생합니다.
function validateRequestProperties()