WebResource interface
원격 서버에 대한 HTTP 요청에 대한 설명입니다.
속성
| abort |
중단 컨트롤러의 신호입니다. 네트워크 요청을 보내고 응답을 기다리는 작업을 모두 중단하는 데 사용할 수 있습니다. |
| agent | NODEJS만 사용자 지정 |
| body | 요청의 HTTP 본문 내용입니다. |
| decompress |
Accept-Encoding 헤더에 따라 응답을 압축 해제할지 여부(노드 인출에만 해당) |
| form |
요청 본문을 빌드하는 데 사용되는 양식 데이터입니다. |
| headers | 요청을 만들 때 사용할 HTTP 헤더입니다. |
| keep |
연결을 다시 사용해야 하는 경우 |
| method | 요청을 할 때 사용할 HTTP 메서드입니다. |
| on |
다운로드 진행 시 발생하는 콜백입니다. |
| on |
업로드 진행률에 따라 발생하는 콜백입니다. |
| proxy |
프록시 구성. |
| query | 개체로 표시되는 쿼리 문자열입니다. |
| request |
요청에 대한 고유 식별자입니다. 로깅 및 추적에 사용됩니다. |
| request |
요청에 대해 설정할 추가 옵션입니다. 이렇게 하면 기존 속성을 재정의하거나 선언되지 않은 요청 속성을 제공할 수 있습니다. 가능한 유효한 속성은 다음을 참조하십시오.
경고: 여기에 지정된 옵션은 에 의해 <xref:HttpClient>요청이 전송될 때 동일한 이름의 속성을 재정의합니다. |
| stream |
HttpOperationResponse의 본문을 스트림으로 처리해야 하는지 여부입니다. |
| stream |
해당 HttpOperationResponse 본문을 스트림으로 처리해야 하는 응답 상태 코드 목록입니다. |
| timeout | 요청이 자동으로 종료되기 전에 걸릴 수 있는 시간(밀리초)입니다.
요청이 종료되면 |
| url | 요청에 의해 액세스되는 URL입니다. |
| with |
XHR 중에 자격 증명(쿠키)을 함께 보내야 하는 경우 |
메서드
| clone() | 이 요청 개체를 복제합니다. |
| prepare(unknown) | 이는 호환성을 위한 no-op 호출되면 throw됩니다. |
| validate |
메서드, URL, 헤더["Content-Type"], 헤더["accept-language"]와 같은 필수 속성이 정의되어 있는지 확인합니다. 위에서 언급한 속성 중 하나가 정의되지 않은 경우 오류가 발생합니다. 참고: 이는 호환성을 위한 no-op. |
속성 세부 정보
abortSignal
중단 컨트롤러의 신호입니다. 네트워크 요청을 보내고 응답을 기다리는 작업을 모두 중단하는 데 사용할 수 있습니다.
abortSignal?: AbortSignalLike
속성 값
agent
NODEJS만
사용자 지정 http.Agent/https.Agent제공하는 노드 전용 옵션입니다.
참고: 일반적으로 서비스에 대한 기본 연결을 다시 사용할 수 있도록 여러 요청에서 공유되는 하나의 인스턴스여야 합니다.
브라우저에서 실행할 때 아무 것도 수행하지 않습니다.
agent?: Agent
속성 값
body
요청의 HTTP 본문 내용입니다.
body?: any
속성 값
any
decompressResponse
Accept-Encoding 헤더에 따라 응답을 압축 해제할지 여부(노드 인출에만 해당)
decompressResponse?: boolean
속성 값
boolean
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
proxySettings
query
개체로 표시되는 쿼리 문자열입니다.
query?: {[key: string]: any}
속성 값
{[key: string]: any}
requestId
요청에 대한 고유 식별자입니다. 로깅 및 추적에 사용됩니다.
requestId: string
속성 값
string
requestOverrides
요청에 대해 설정할 추가 옵션입니다. 이렇게 하면 기존 속성을 재정의하거나 선언되지 않은 요청 속성을 제공할 수 있습니다.
가능한 유효한 속성은 다음을 참조하십시오.
- NodeJS https.request 옵션: https://nodejs.org/api/http.html#httprequestoptions-callback
- 브라우저 RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit
경고: 여기에 지정된 옵션은 에 의해 <xref:HttpClient>요청이 전송될 때 동일한 이름의 속성을 재정의합니다.
requestOverrides?: Record<string, unknown>
속성 값
Record<string, unknown>
streamResponseBody
경고
이 API는 이제 사용되지 않습니다.
Use streamResponseStatusCodes property instead.
HttpOperationResponse의 본문을 스트림으로 처리해야 하는지 여부입니다.
streamResponseBody?: boolean
속성 값
boolean
streamResponseStatusCodes
해당 HttpOperationResponse 본문을 스트림으로 처리해야 하는 응답 상태 코드 목록입니다.
streamResponseStatusCodes?: Set<number>
속성 값
Set<number>
timeout
요청이 자동으로 종료되기 전에 걸릴 수 있는 시간(밀리초)입니다.
요청이 종료되면 AbortError throw됩니다.
timeout: number
속성 값
number
url
요청에 의해 액세스되는 URL입니다.
url: string
속성 값
string
withCredentials
XHR 중에 자격 증명(쿠키)을 함께 보내야 하는 경우
withCredentials: boolean
속성 값
boolean
메서드 세부 정보
clone()
prepare(unknown)
이는 호환성을 위한 no-op 호출되면 throw됩니다.
function prepare(options: unknown): WebResourceLike
매개 변수
- options
-
unknown
반환
validateRequestProperties()
메서드, URL, 헤더["Content-Type"], 헤더["accept-language"]와 같은 필수 속성이 정의되어 있는지 확인합니다. 위에서 언급한 속성 중 하나가 정의되지 않은 경우 오류가 발생합니다. 참고: 이는 호환성을 위한 no-op.
function validateRequestProperties()