UNPKG

1.11 kBTypeScriptView Raw
1/// <reference types="node" />
2import { Readable } from 'stream';
3import { StreamableFileOptions, StreamableHandlerResponse } from './interfaces';
4import { Logger } from '../services';
5/**
6 * @see [Streaming files](https://docs.nestjs.com/techniques/streaming-files)
7 *
8 * @publicApi
9 */
10export declare class StreamableFile {
11 readonly options: StreamableFileOptions;
12 private readonly stream;
13 protected logger: Logger;
14 protected handleError: (err: Error, response: StreamableHandlerResponse) => void;
15 protected logError: (err: Error) => void;
16 constructor(buffer: Uint8Array, options?: StreamableFileOptions);
17 constructor(readable: Readable, options?: StreamableFileOptions);
18 getStream(): Readable;
19 getHeaders(): {
20 type: string;
21 disposition: string;
22 length: number;
23 };
24 get errorHandler(): (err: Error, response: StreamableHandlerResponse) => void;
25 setErrorHandler(handler: (err: Error, response: StreamableHandlerResponse) => void): this;
26 get errorLogger(): (err: Error) => void;
27 setErrorLogger(handler: (err: Error) => void): this;
28}