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、headers["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、headers["Content-Type"]、headers["accept-language"] などの必須プロパティが定義されていることを検証します。 上記のプロパティのいずれかが定義されていない場合は、エラーがスローされます。
function validateRequestProperties()