WebResourceLike interface
リモート サーバーに対して行われる HTTP 要求の説明。
プロパティ
| abort |
中止コントローラーの信号。 ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。 |
| body | 要求の HTTP 本文の内容。 |
| decompress |
Accept-Encoding ヘッダーに従って応答を展開するかどうか (ノード フェッチのみ) |
| form |
フォーム データ。要求本文の構築に使用されます。 |
| headers | 要求を行うときに使用する HTTP ヘッダー。 |
| keep |
接続を再利用する必要がある場合。 |
| method | 要求を行うときに使用する HTTP メソッド。 |
| on |
ダウンロードの進行状況時に発生するコールバック。 |
| on |
アップロードの進行状況時に発生するコールバック。 |
| operation |
指定された OperationSpec と HttpOperationResponse の組み合わせに対して適切な OperationResponse を返す関数。 これが未定義の場合は、単純な状態コード参照が使用されます。 |
| operation |
応答を解析するために使用されます。 |
| proxy |
プロキシの構成。 |
| query | オブジェクトとして表されるクエリ文字列。 |
| request |
要求の一意識別子。 ログ記録とトレースに使用されます。 |
| should |
HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。 |
| stream |
HttpOperationResponse の本文をストリームとして扱う必要があるかどうか。 |
| stream |
対応する HttpOperationResponse 本文をストリームとして扱う必要がある応答状態コードの一覧。 |
| timeout | 要求が自動的に終了するまでの時間 (ミリ秒)。
要求が終了すると、 |
| tracing |
トレース: スパンの作成時に使用されるコンテキスト。 |
| url | 要求によってアクセスされる URL。 |
| with |
XHR 中に資格情報 (Cookie) を送信する必要がある場合。 |
メソッド
| clone() | この要求オブジェクトを複製します。 |
| prepare(Request |
要求のオプションを設定します。 |
| validate |
メソッド、url、headers["Content-Type"]、headers["accept-language"] などの必須プロパティが定義されていることを検証します。 上記のプロパティのいずれかが定義されていない場合、エラーがスローされます。 |
プロパティの詳細
abortSignal
中止コントローラーの信号。 ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。
abortSignal?: AbortSignalLikeプロパティ値
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
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}
requestId
要求の一意識別子。 ログ記録とトレースに使用されます。
requestId: stringプロパティ値
string
shouldDeserialize
HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。
shouldDeserialize?: boolean | (response: HttpOperationResponse) => booleanプロパティ値
boolean | (response: HttpOperationResponse) => boolean
streamResponseBody
警告
この API は非推奨になりました。
Use streamResponseStatusCodes property instead.
HttpOperationResponse の本文をストリームとして扱う必要があるかどうか。
streamResponseBody?: booleanプロパティ値
boolean
streamResponseStatusCodes
対応する HttpOperationResponse 本文をストリームとして扱う必要がある応答状態コードの一覧。
streamResponseStatusCodes?: Set<number>プロパティ値
Set<number>
timeout
要求が自動的に終了するまでの時間 (ミリ秒)。
要求が終了すると、AbortError がスローされます。
timeout: numberプロパティ値
number
tracingContext
トレース: スパンの作成時に使用されるコンテキスト。
tracingContext?: Contextプロパティ値
url
要求によってアクセスされる URL。
url: stringプロパティ値
string
withCredentials
XHR 中に資格情報 (Cookie) を送信する必要がある場合。
withCredentials: booleanプロパティ値
boolean
メソッドの詳細
clone()
prepare(RequestPrepareOptions)
要求のオプションを設定します。
function prepare(options: RequestPrepareOptions): WebResourceLikeパラメーター
- options
- RequestPrepareOptions
戻り値
validateRequestProperties()
メソッド、url、headers["Content-Type"]、headers["accept-language"] などの必須プロパティが定義されていることを検証します。 上記のプロパティのいずれかが定義されていない場合、エラーがスローされます。
function validateRequestProperties()