IRetriableReadableStreamOptions interface

Package:

@azure/storage-file

Properties

doInjectErrorOnce	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.
maxRetryRequests	Max retry count (>=0), undefined or invalid value means no retry
progress	Read progress event handler

Property Details

doInjectErrorOnce

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.

doInjectErrorOnce?: undefined | false | true

Property Value

undefined | false | true

maxRetryRequests

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

maxRetryRequests?: undefined | number

Property Value

undefined | number

progress

Read progress event handler

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

Property Value

undefined | (progress: TransferProgressEvent) => void