RetriableReadableStreamOptions | @azure/storage-blob

Hierarchy

RetriableReadableStreamOptions

Index

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.

memberof: RetriableReadableStreamOptions

Optional doInjectErrorOnce

doInjectErrorOnce: undefined | false | true

Debug purpose only. Used to inject an unexpected end to existing internal stream, to test stream retry works well or not.

When assign it to true, for next incoming "data" event of internal stream, RetriableReadableStream will try to emit an "end" event to existing internal stream to force it end and start retry from the breaking point. The value will then update to "undefined", once the injection works.

memberof: RetriableReadableStreamOptions

Optional maxRetryRequests

maxRetryRequests: undefined | number

Max retry count (>=0), undefined or invalid value means no retry

memberof: RetriableReadableStreamOptions

Optional onProgress

onProgress: undefined | ((progress: TransferProgressEvent) => void)

Read progress event handler

memberof: RetriableReadableStreamOptions