Class FormData<FormDataType>

The result when parsing multipart/form-data request bodies. Has a resolved object with all the request bodies values on their respective keys.

Type Parameters

FormDataType extends object

Index

Properties

tempFolder value

Methods

Properties

`Readonly`tempFolder

tempFolder: Path

The temporary folder where all files are cached. Should be deleted after you handled the form data with the cleanup method.

`Readonly`value

value: FormDataType

The resolved value as an object, containing all files and values correctly typed.

Methods

cleanup

cleanup(): Promise<void>
Deletes all temporary files belonging to this form data.

Returns Promise<void>
- Defined in src/parsing/form-data/form-data.model.ts:59

`Static`create

create<FormDataType extends object>(
    value: FormDataType,
    tempFolder: Path,
    cleanupAfterMs: number,
): Promise<FormData<FormDataType>>
Creates a new form data object from the given input.
Type Parameters
- FormDataType extends object
Parameters
- value: FormDataType
  The actual value of the form data.
- tempFolder: Path
  The temporary folder that was created on uploading the form data.
- cleanupAfterMs: number
  A timeout after which the temporary folder is save to delete.
Returns Promise<FormData<FormDataType>>
A new FormData object.
- Defined in src/parsing/form-data/form-data.model.ts:43