From c5d08c81ef5de8fe67060164ee934860236e825d Mon Sep 17 00:00:00 2001 From: "Micael Levi L. Cavalcante" Date: Wed, 3 Jul 2024 14:18:02 -0400 Subject: [PATCH] docs(common): add docs to `StreamableFile` options --- .../interfaces/streamable-options.interface.ts | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/packages/common/file-stream/interfaces/streamable-options.interface.ts b/packages/common/file-stream/interfaces/streamable-options.interface.ts index bd9616b5cf8..fe6b698e41d 100644 --- a/packages/common/file-stream/interfaces/streamable-options.interface.ts +++ b/packages/common/file-stream/interfaces/streamable-options.interface.ts @@ -1,10 +1,22 @@ /** * Options for `StreamableFile` * + * @see [Streaming files](https://docs.nestjs.com/techniques/streaming-files) + * * @publicApi */ export interface StreamableFileOptions { + /** + * The value that will be used for the `Content-Type` response header. + * @default `"application/octet-stream"` + */ type?: string; + /** + * The value that will be used for the `Content-Disposition` response header. + */ disposition?: string; + /** + * The value that will be used for the `Content-Length` response header. + */ length?: number; }