FileParallelUploadOptions | @azure/storage-file-share

Option interface for ShareFileClient.uploadFile() and ShareFileClient.uploadSeekableStream().

export
interface: FileParallelUploadOptions

Hierarchy

CommonOptions
- FileParallelUploadOptions

Index

Properties

Optional abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

type: {AbortSignalLike}
memberof: FileParallelUploadOptions

Optional concurrency

concurrency: undefined | number

Concurrency indicates the maximum number of ranges to upload in parallel. If not provided, 5 concurrency will be used by default.

type: {number}
memberof: FileParallelUploadOptions

Optional fileHttpHeaders

fileHttpHeaders: FileHttpHeaders

File HTTP Headers.

type: {FileHttpHeaders}
memberof: FileParallelUploadOptions

Optional metadata

metadata: Metadata

Metadata of an Azure file.

type: {Metadata}
memberof: FileParallelUploadOptions

Optional onProgress

onProgress: undefined | function

Progress updater.

memberof: FileParallelUploadOptions

Optional rangeSize

rangeSize: undefined | number

RangeSize specifies the range size to use in each parallel upload, the default (and maximum size) is FILE_RANGE_MAX_SIZE_BYTES.

type: {number}
memberof: FileParallelUploadOptions

Optional tracingOptions

tracingOptions: OperationTracingOptions