StreamableFile

  
class StreamableFile {
  constructor(bufferOrReadStream: Uint8Array | Readable, options: StreamableFileOptions = {})
  protected handleError: (err: Error, response: StreamableHandlerResponse) => void
  options: StreamableFileOptions
  errorHandler: (err: Error, response: StreamableHandlerResponse) => void
  getStream(): Readable
  getHeaders()
  setErrorHandler(handler: (err: Error, response: StreamableHandlerResponse) => void)
}

See also

Constructor


constructor(buffer: Uint8Array, options?: StreamableFileOptions)

Parameters

Option Type Description
buffer Uint8Array
options StreamableFileOptions

Optional. Default is undefined.


constructor(readable: Readable, options?: StreamableFileOptions)

Parameters

Option Type Description
readable Readable
options StreamableFileOptions

Optional. Default is undefined.

Properties

Property Description
protected handleError: (err: Error, response: StreamableHandlerResponse) => void
options: StreamableFileOptions Read-only. Declared in constructor.
errorHandler: (err: Error, response: StreamableHandlerResponse) => void Read-only.

Methods

getStream()


getStream(): Readable

Parameters

There are no parameters.

Returns

Readable

getHeaders()


getHeaders()

Parameters

There are no parameters.

setErrorHandler()


setErrorHandler(handler: (err: Error, response: StreamableHandlerResponse) => void)

Parameters

Option Type Description
handler (err: Error, response: StreamableHandlerResponse) => void