WebResourceLike interface

패키지:

@azure/ms-rest-js

REST 호출에 대한 추상화입니다.

속성

abortSignal	나중에 요청을 중단하는 데 사용됩니다.
agentSettings	HTTP(S) 에이전트 구성.
body	요청의 HTTP 본문 콘텐츠입니다.
formData
headers	요청을 만들 때 사용할 HTTP 헤더입니다.
keepAlive	연결을 다시 사용해야 하는 경우.
method	요청을 만들 때 사용할 HTTP 메서드입니다.
onDownloadProgress	다운로드 진행 시 발생하는 콜백입니다.
onUploadProgress	업로드 진행 시 발생하는 콜백입니다.
operationResponseGetter	지정된 OperationSpec 및 HttpOperationResponse 조합에 대한 적절한 OperationResponse를 반환하는 함수입니다. 정의되지 않은 경우 간단한 상태 코드 조회가 사용됩니다.
operationSpec	응답을 구문 분석하는 데 사용됩니다.
proxySettings	프록시 구성.
query	개체로 표시되는 쿼리 문자열입니다.
redirectLimit	이 요청에 대해 수행되는 리디렉션 수를 제한합니다. 0으로 설정하면 리디렉션이 수행되지 않습니다. 정의되지 않은 상태로 두면 기본 node_fetch 기본 리디렉션 동작이 적용됩니다.
shouldDeserialize	HttpOperationResponse를 역직렬화해야 하는지 여부입니다. 정의되지 않은 경우 HttpOperationResponse를 역직렬화해야 합니다.
streamResponseBody	HttpOperationResponse의 본문을 스트림으로 처리해야 하는지 여부입니다.
timeout	요청이 자동으로 종료되기 전에 걸릴 수 있는 시간(밀리초)입니다. 요청이 종료되면 가 AbortError throw됩니다.
url	요청에 의해 액세스되는 URL입니다.
withCredentials	XHR 중에 자격 증명(쿠키)을 함께 보내야 하는 경우

메서드

clone()	이 요청 개체를 복제합니다.
prepare(RequestPrepareOptions)	요청에 대한 옵션을 설정합니다.
validateRequestProperties()	메서드, URL, 헤더["Content-Type"], headers["accept-language"]와 같은 필수 속성이 정의되어 있는지 확인합니다. 위에서 언급한 속성 중 하나가 정의되지 않은 경우 오류가 발생합니다.

속성 세부 정보

abortSignal

나중에 요청을 중단하는 데 사용됩니다.

abortSignal?: AbortSignalLike

속성 값

AbortSignalLike

agentSettings

HTTP(S) 에이전트 구성.

agentSettings?: AgentSettings

속성 값

AgentSettings

body

요청의 HTTP 본문 콘텐츠입니다.

body?: any

속성 값

any

formData

formData?: any

속성 값

any

headers

요청을 만들 때 사용할 HTTP 헤더입니다.

headers: HttpHeadersLike

속성 값

HttpHeadersLike

keepAlive

연결을 다시 사용해야 하는 경우.

keepAlive?: boolean

속성 값

boolean

method

요청을 만들 때 사용할 HTTP 메서드입니다.

method: HttpMethods

속성 값

HttpMethods

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

응답을 구문 분석하는 데 사용됩니다.

operationSpec?: OperationSpec

속성 값

OperationSpec

proxySettings

프록시 구성.

proxySettings?: ProxySettings

속성 값

ProxySettings

query

개체로 표시되는 쿼리 문자열입니다.

query?: {[key: string]: any}

속성 값

{[key: string]: any}

redirectLimit

이 요청에 대해 수행되는 리디렉션 수를 제한합니다. 0으로 설정하면 리디렉션이 수행되지 않습니다. 정의되지 않은 상태로 두면 기본 node_fetch 기본 리디렉션 동작이 적용됩니다.

redirectLimit?: number

속성 값

number

shouldDeserialize

HttpOperationResponse를 역직렬화해야 하는지 여부입니다. 정의되지 않은 경우 HttpOperationResponse를 역직렬화해야 합니다.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

속성 값

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

HttpOperationResponse의 본문을 스트림으로 처리해야 하는지 여부입니다.

streamResponseBody?: boolean

속성 값

boolean

timeout

요청이 자동으로 종료되기 전에 걸릴 수 있는 시간(밀리초)입니다. 요청이 종료되면 가 AbortError throw됩니다.

timeout: number

속성 값

number

url

요청에 의해 액세스되는 URL입니다.

url: string

속성 값

string

withCredentials

XHR 중에 자격 증명(쿠키)을 함께 보내야 하는 경우

withCredentials: boolean

속성 값

boolean

메서드 세부 정보

clone()

이 요청 개체를 복제합니다.

function clone(): WebResourceLike

반환

WebResourceLike

prepare(RequestPrepareOptions)

요청에 대한 옵션을 설정합니다.

function prepare(options: RequestPrepareOptions): WebResourceLike

매개 변수

options

RequestPrepareOptions

반환

WebResourceLike

validateRequestProperties()

메서드, URL, 헤더["Content-Type"], headers["accept-language"]와 같은 필수 속성이 정의되어 있는지 확인합니다. 위에서 언급한 속성 중 하나가 정의되지 않은 경우 오류가 발생합니다.

function validateRequestProperties()