-
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(common): add docs to
StreamableFile
options
- Loading branch information
1 parent
9b4aa27
commit c5d08c8
Showing
1 changed file
with
12 additions
and
0 deletions.
There are no files selected for viewing
12 changes: 12 additions & 0 deletions
12
packages/common/file-stream/interfaces/streamable-options.interface.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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; | ||
} |