PipelineRequestOptions interface
要求を初期化するための設定。 Partial<PipelineRequest>とほぼ同じですが、urlは必須です。
プロパティ
| abort |
後で要求を中止するために使用されます。 |
| body | HTTP 本文の内容 (存在する場合) |
| form |
ブラウザー フォームの投稿をシミュレートするには |
| headers | 要求を行うときに使用する HTTP ヘッダー。 |
| keep |
接続を再利用する必要がある場合。 既定値は true です。 |
| method | 要求を行うときに使用する HTTP メソッド。 |
| on |
ダウンロードの進行状況時に発生するコールバック。 |
| on |
アップロードの進行状況時に発生するコールバック。 |
| proxy |
プロキシ構成。 |
| request |
要求の一意の識別子。 ログ記録とトレースに使用されます。 |
| span |
トレースが有効な場合にスパンを作成するために使用されるオプション。 |
| stream |
対応する PipelineResponse 本文をストリームとして扱う必要がある応答状態コードの一覧。 |
| timeout | 要求が自動的に終了するまでの時間 (ミリ秒)。
要求が終了すると、 |
| url | 要求を行う URL。 |
| with |
XHR 中に資格情報 (Cookie) を送信する必要がある場合。 既定値は false です。 |
プロパティの詳細
abortSignal
body
formData
headers
keepAlive
接続を再利用する必要がある場合。 既定値は true です。
keepAlive?: booleanプロパティ値
boolean
method
onDownloadProgress
ダウンロードの進行状況時に発生するコールバック。
onDownloadProgress?: (progress: TransferProgressEvent) => voidプロパティ値
(progress: TransferProgressEvent) => void
onUploadProgress
アップロードの進行状況時に発生するコールバック。
onUploadProgress?: (progress: TransferProgressEvent) => voidプロパティ値
(progress: TransferProgressEvent) => void
proxySettings
requestId
要求の一意の識別子。 ログ記録とトレースに使用されます。
requestId?: stringプロパティ値
string
spanOptions
トレースが有効な場合にスパンを作成するために使用されるオプション。
spanOptions?: SpanOptionsプロパティ値
streamResponseStatusCodes
対応する PipelineResponse 本文をストリームとして扱う必要がある応答状態コードの一覧。
streamResponseStatusCodes?: Set<number>プロパティ値
Set<number>
timeout
要求が自動的に終了するまでの時間 (ミリ秒)。
要求が終了すると、AbortError がスローされます。
既定値は 0 で、タイムアウトを無効にします。
timeout?: numberプロパティ値
number
url
要求を行う URL。
url: stringプロパティ値
string
withCredentials
XHR 中に資格情報 (Cookie) を送信する必要がある場合。 既定値は false です。
withCredentials?: booleanプロパティ値
boolean
