FileUploadStreamOptions | @azure/storage-file-share

Option interface for ShareFileClient.uploadStream().

export
interface: FileUploadStreamOptions

Hierarchy

CommonOptions
- FileUploadStreamOptions

Index

Properties

abortSignal
fileHttpHeaders
metadata
onProgress
tracingOptions

Properties

Optional abortSignal

abortSignal: AbortSignalLike

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: FileUploadStreamOptions

Optional fileHttpHeaders

fileHttpHeaders: FileHttpHeaders

Azure File HTTP Headers.

type: {FileHttpHeaders}
memberof: FileUploadStreamOptions

Optional metadata

metadata: Metadata

Metadata of the Azure file.

type: {Metadata}
memberof: FileUploadStreamOptions

Optional onProgress

onProgress: undefined | function

Progress updater.

memberof: FileUploadStreamOptions

Optional tracingOptions

tracingOptions: OperationTracingOptions