RequestOptionsBase interface
すべての操作で使用される options オブジェクトの基本構造について説明します。
プロパティ
| abort |
中止コントローラーのシグナル。 ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。 |
| custom |
は、要求が送信される前に適用されます。 |
| on |
ダウンロードの進行状況時に発生するコールバック。 |
| on |
アップロードの進行状況時に発生するコールバック。 |
| serializer |
XML 解析/構築の動作をオーバーライドするオプション。 |
| should |
HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。 |
| timeout | 要求が自動的に終了するまでの時間 (ミリ秒)。
要求が終了すると、 |
| tracing |
トレース: スパンの作成時に使用されるコンテキスト。 |
プロパティの詳細
abortSignal
中止コントローラーのシグナル。 ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。
abortSignal?: AbortSignalLikeプロパティ値
customHeaders
は、要求が送信される前に適用されます。
customHeaders?: {[key: string]: string}プロパティ値
{[key: string]: string}
onDownloadProgress
ダウンロードの進行状況時に発生するコールバック。
onDownloadProgress?: (progress: TransferProgressEvent) => voidプロパティ値
(progress: TransferProgressEvent) => void
onUploadProgress
アップロードの進行状況時に発生するコールバック。
onUploadProgress?: (progress: TransferProgressEvent) => voidプロパティ値
(progress: TransferProgressEvent) => void
serializerOptions
shouldDeserialize
HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。
shouldDeserialize?: boolean | (response: HttpOperationResponse) => booleanプロパティ値
boolean | (response: HttpOperationResponse) => boolean
timeout
要求が自動的に終了するまでの時間 (ミリ秒)。
要求が終了すると、 AbortError がスローされます。
timeout?: numberプロパティ値
number
tracingContext
トレース: スパンの作成時に使用されるコンテキスト。
tracingContext?: Context