tsoa-next / @tsoa-next/runtime / File

Interface: File

Defined in: packages/runtime/src/interfaces/file.ts:4

Object containing file metadata and access information.

Properties

buffer

buffer: Buffer;

Defined in: packages/runtime/src/interfaces/file.ts:31

MemoryStorage only: A Buffer containing the entire file.

---

destination

destination: string;

Defined in: packages/runtime/src/interfaces/file.ts:25

DiskStorage only: Directory to which this file has been uploaded.

---

encoding

encoding: string;

Defined in: packages/runtime/src/interfaces/file.ts:14

Value of the Content-Transfer-Encoding header for this file.

Deprecated

since July 2015

See

RFC 7578, Section 4.7

---

fieldname

fieldname: string;

Defined in: packages/runtime/src/interfaces/file.ts:6

Name of the form field associated with this file.

---

filename

filename: string;

Defined in: packages/runtime/src/interfaces/file.ts:27

DiskStorage only: Name of this file within destination.

---

mimetype

mimetype: string;

Defined in: packages/runtime/src/interfaces/file.ts:16

Value of the Content-Type header for this file.

---

originalname

originalname: string;

Defined in: packages/runtime/src/interfaces/file.ts:8

Name of the file on the uploader's computer.

---

path

path: string;

Defined in: packages/runtime/src/interfaces/file.ts:29

DiskStorage only: Full path to the uploaded file.

---

size

size: number;

Defined in: packages/runtime/src/interfaces/file.ts:18

Size of the file in bytes.

---

stream

stream: Readable;

Defined in: packages/runtime/src/interfaces/file.ts:23

A readable stream of this file. Only available to the _handleFile callback for custom StorageEngines.