Class FileResponse

A file response.

Index

Properties

data filename mimeType size

Methods

fromPath fromStream

Properties

`Readonly`data

data: string | Readable

`Readonly`filename

filename: string

`Readonly`mimeType

mimeType: LooseFileMimeType

`Readonly`size

size: undefined | number

Methods

`Static`fromPath

fromPath(
p: string,
options?: OmitStrict<PathFileResponseData, "path">,
): Promise<FileResponse>
Creates a new FileResponse from the given path and options.
Parameters
- p: string
  The path of the file to return.
- Optionaloptions: OmitStrict<PathFileResponseData, "path">
  Additional options like file size.
Returns Promise<FileResponse>
A new FileResponse.
- Defined in src/parsing/form-data/file-response.model.ts:73

`Static`fromStream

fromStream(input: StreamFileResponseData): FileResponse
Creates a new FileResponse from the given input.
Parameters
- input: StreamFileResponseData
  The input with the stream, file name etc.
Returns FileResponse
A new FileResponse.
- Defined in src/parsing/form-data/file-response.model.ts:96