RequestOptionsBase interface

パッケージ:

@azure/ms-rest-js

すべての操作で使用される options オブジェクトの基本構造について説明します。

プロパティ

abortSignal	要求を中止するために使用できるシグナル。
customHeaders	要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。
onDownloadProgress	ダウンロードの進行状況時に発生するコールバック。
onUploadProgress	アップロードの進行状況時に発生するコールバック。
timeout	要求が自動的に終了するまでの時間 (ミリ秒)。

プロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

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

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。

timeout?: number

プロパティ値

number