class StreamableFile {
constructor(bufferOrReadStream: Uint8Array | Readable, options: StreamableFileOptions = {})
protected logger: Logger
protected handleError: (err: Error, response: StreamableHandlerResponse) => void
protected logError: (err: Error) => void
options: StreamableFileOptions
errorHandler: (err: Error, response: StreamableHandlerResponse) => void
errorLogger
getStream(): Readable
getHeaders()
setErrorHandler(handler: (err: Error, response: StreamableHandlerResponse) => void)
setErrorLogger(handler: (err: Error) => void)
}
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 logger: Logger
|
|
protected handleError: (err: Error, response: StreamableHandlerResponse) => void
|
|
protected logError: (err: Error) => void
|
|
options: StreamableFileOptions
|
Read-only.
Declared in constructor.
|
errorHandler: (err: Error, response: StreamableHandlerResponse) => void
|
Read-only.
|
errorLogger
|
Read-only.
|
Methods
getStream()
|
|---|
getStream(): Readable
Parameters
There are no parameters.
Returns
Readable
|
|
|
|---|
getHeaders()
Parameters
There are no parameters.
|
setErrorHandler()
|
|---|
setErrorHandler(handler: (err: Error, response: StreamableHandlerResponse) => void)
Parameters
| Option |
Type |
Description |
handler
|
(err: Error, response: StreamableHandlerResponse) => void |
|
|
setErrorLogger()
|
|---|
setErrorLogger(handler: (err: Error) => void)
Parameters
| Option |
Type |
Description |
handler
|
(err: Error) => void |
|
|
