Skip to content

Commit

Permalink
docs(common): add docs to StreamableFile options
Browse files Browse the repository at this point in the history
  • Loading branch information
micalevisk committed Jul 3, 2024
1 parent 9b4aa27 commit c5d08c8
Showing 1 changed file with 12 additions and 0 deletions.
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;
}

0 comments on commit c5d08c8

Please sign in to comment.