@adonisjs/bodyparser

constructor

constructor(
    ctx: HttpContext,
    config?: Partial<{
        limit: string | number;
        fieldsLimit: string | number;
        maxFields: number;
        convertEmptyStringsToNull: boolean;
    }>
);

property state

state: 'idle' | 'processing' | 'error' | 'success';

• The current state of the multipart form handler

method abort

abort: (error: any) => void;

• Abort request by emitting error

method onFile

onFile: (
    name: string,
    options: Partial<FileValidationOptions & { deferValidations: boolean }>,
    handler: PartHandlerType
) => this;

• Attach handler for a given file. To handle all files, you can attach a wildcard handler.

  Example 1

  multipart.onFile('package', {}, async (stream) => {
  })
  
  multipart.onFile('*', {}, async (stream) => {
  })

method process

process: (
    config?: Partial<{ limit: string | number; maxFields: number }>
) => Promise<void>;

• Process the request by going all the file and field streams.

constructor

constructor(
    data: { fieldName: string; clientName: string; headers: any },
    validationOptions: Partial<FileValidationOptions>
);

property allowedExtensions

allowedExtensions: string[];

• Extensions allowed

property clientName

clientName: string;

• Client name is the file name on the user client

property errors

errors: FileUploadError[];

• Upload errors

property extname

extname?: string;

• The extname for the file.

property fieldName

fieldName: string;

• Field name is the name of the field

property fileName

fileName?: string;

• File name is only set after the move operation. It is the relative path of the moved file

property filePath

filePath?: string;

• File path is only set after the move operation

property hasErrors

readonly hasErrors: boolean;

• Opposite of [[this.isValid]]

property headers

headers: Record<string, any>;

• The headers sent as part of the multipart request

property isMultipartFile

isMultipartFile: boolean;

• A boolean to know if file is an instance of this class or not

property isValid

readonly isValid: boolean;

• A boolean to know if file has one or more errors

property meta

meta: any;

• The file meta data

property size

size: number;

• File size in bytes

property sizeLimit

sizeLimit: string | number;

• The maximum file size limit

property state

state: 'idle' | 'streaming' | 'consumed' | 'moved';

• The state of the file

property subtype

subtype?: string;

property tmpPath

tmpPath?: string;

• Tmp path, only exists when file is uploaded using the classic mode.

property type

type?: string;

• Type and subtype are extracted from the content-type header or from the file magic number

property validated

readonly validated: boolean;

• Whether or not the validations have been executed

method markAsMoved

markAsMoved: (fileName: string, filePath: string) => void;

• Mark file as moved

method move

move: (
    location: string,
    options?: { name?: string; overwrite?: boolean }
) => Promise<void>;

• Moves the file to a given location. Multiple calls to the move method are allowed, incase you want to move a file to multiple locations.

method toJSON

toJSON: () => FileJSON;

• Returns file JSON representation

method validate

validate: () => void;

• Validate the file