FileUploadRangeOptionalParams interface

Package:

@azure/storage-file

Optional Parameters.

Extends

RequestOptionsBase

Properties

abortSignal	The signal which can be used to abort requests.
contentMD5	An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request).
customHeaders	{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
optionalbody	Initial data.
timeout	The number of milliseconds a request can take before automatically being terminated.
timeoutParameter	The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

contentMD5

An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request).

contentMD5?: Uint8Array

Property Value

Uint8Array

customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

customHeaders?: undefined | [key: string]: string

Property Value

undefined | [key: string]: string

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: undefined | (progress: TransferProgressEvent) => void

Property Value

undefined | (progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: undefined | (progress: TransferProgressEvent) => void

Property Value

undefined | (progress: TransferProgressEvent) => void

optionalbody

Initial data.

optionalbody?: msRest.HttpRequestBody

Property Value

msRest.HttpRequestBody

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: undefined | number

Property Value

undefined | number

timeoutParameter

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.

timeoutParameter?: undefined | number

Property Value

undefined | number