Class RetriableReadableStream

Package version

ONLY AVAILABLE IN NODE.JS RUNTIME.

A Node.js ReadableStream will internally retry when internal ReadableStream unexpected ends.

Hierarchy

any
- RetriableReadableStream

Index

Constructors

constructor

Methods

Constructors

constructor

new RetriableReadableStream(source: NodeJS.ReadableStream, getter: ReadableStreamGetter, offset: number, count: number, options?: RetriableReadableStreamOptions): RetriableReadableStream

- Defined in storage-blob/src/utils/RetriableReadableStream.ts:51
Creates an instance of RetriableReadableStream.

Parameters
- source: NodeJS.ReadableStream
  
  The current ReadableStream returned from getter
- getter: ReadableStreamGetter
  
  A method calling downloading request returning a new ReadableStream from specified offset
- offset: number
  
  Offset position in original data source to read
- count: number
  
  How much data in original data source to read
- Default value options: RetriableReadableStreamOptions = {}
  
  -
Returns RetriableReadableStream

Methods

_destroy

_destroy(error: Error | null, callback: (error?: Error) => void): void

- Defined in storage-blob/src/utils/RetriableReadableStream.ts:171
Parameters
- error: Error | null
- callback: (error?: Error) => void
  - - (error?: Error): void
    - Parameters
      - Optional error: Error
      Returns void
Returns void

_read

_read(): void

- Defined in storage-blob/src/utils/RetriableReadableStream.ts:84
Returns void

Generated using TypeDoc