@adonisjs/bodyparser

@adonisjs/bodyparser

Version 8.1.7
Published 7 months ago
80.6 kB
9 dependencies
MIT license

Install

npm i @adonisjs/bodyparser

yarn add @adonisjs/bodyparser

pnpm add @adonisjs/bodyparser

Overview

AdonisJs body parser to read and parse HTTP request bodies

Classes

class BodyParserProvider

class BodyParserProvider {}

constructor

constructor(app: ApplicationContract);

property app

protected app: ApplicationContract;

property needsApplication

static needsApplication: boolean;

method boot

boot: () => void;

Adding the file macro to add support for reading request files.

method register

register: () => void;

Registers the bodyparser middleware namespace to the container.

Namespaces

namespace @ioc:Adonis/Core/BodyParser

module '@ioc:Adonis/Core/BodyParser' {}

variable BodyParserMiddleware

const BodyParserMiddleware: BodyParserMiddlewareContract;

interface BodyParserMiddlewareContract

interface BodyParserMiddlewareContract {}

Shape of the bodyparser middleware class constructor

construct signature

new (config: BodyParserConfig): {
    handle(ctx: HttpContextContract, next: () => void): any;
};

interface MultipartContract

interface MultipartContract {}

Multipart class contract, since it is exposed on the request object, we need the interface to extend typings.

property state

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

method abort

abort: (error: any) => void;

method onFile

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

method process

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

interface MultipartFileContract

interface MultipartFileContract {}

Multipart file interface

property allowedExtensions

allowedExtensions?: string[];

property clientName

clientName: string;

property errors

errors: FileUploadError[];

property extname

extname?: string;

property fieldName

fieldName: string;

property fileName

fileName?: string;

property filePath

filePath?: string;

property hasErrors

hasErrors: boolean;

property headers

headers: {
    [key: string]: string;
};

property isMultipartFile

isMultipartFile: true;

property isValid

isValid: boolean;

property meta

meta: any;

property size

size: number;

property sizeLimit

sizeLimit?: number | string;

property state

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

property subtype

subtype?: string;

property tmpPath

tmpPath?: string;

property type

type?: string;

property validated

validated: boolean;

method markAsMoved

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

Mark file as moved

method move

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

Move file from temporary path to a different location. Self consumed streams cannot be moved unless tmpPath is defined explicitly.

method moveToDisk

moveToDisk: (
    location: string,
    options?: WriteOptions & { name?: string },
    diskName?: keyof DisksList
) => Promise<void>;

Move file to a pre-registered drive disk

method toJSON

toJSON: () => FileJSON;

Get JSON representation of file

method validate

validate: () => void;

Run validations on the file

type BodyParserConfig

type BodyParserConfig = {
    whitelistedMethods: string[];
    json: BodyParserJSONConfig;
    form: BodyParserFormConfig;
    raw: BodyParserRawConfig;
    multipart: BodyParserMultipartConfig;
};

Body parser config for all different types

type BodyParserFormConfig

type BodyParserFormConfig = BodyParserBaseConfig & {
    queryString: QueryStringConfig;
    convertEmptyStringsToNull: boolean;
};

Parser config for parsing form data

type BodyParserJSONConfig

type BodyParserJSONConfig = BodyParserBaseConfig & {
    strict: boolean;
};

Body parser config for parsing JSON requests

type BodyParserMultipartConfig

type BodyParserMultipartConfig = BodyParserBaseConfig & {
    autoProcess: boolean;
    maxFields: number;
    processManually: string[];
    convertEmptyStringsToNull: boolean;
    fieldsLimit?: number | string;
    tmpFileName?(): string;
};

Parser config for parsing multipart requests

type BodyParserRawConfig

type BodyParserRawConfig = BodyParserBaseConfig & {
    queryString: QueryStringConfig;
};

Parser config for parsing raw body (untouched)

type FileJSON

type FileJSON = {
    fieldName: string;
    clientName: string;
    size: number;
    filePath?: string;
    type?: string;
    extname?: string;
    subtype?: string;
    state: 'idle' | 'streaming' | 'consumed' | 'moved';
    isValid: boolean;
    validated: boolean;
    errors: FileUploadError[];
    meta: any;
};

Shape of file.toJSON return value

type FileUploadError

type FileUploadError = {
    fieldName: string;
    clientName: string;
    message: string;
    type: 'size' | 'extname' | 'fatal';
};

Error shape for file upload errors

type FileValidationOptions

type FileValidationOptions = {
    size: string | number;
    extnames: string[];
};

The options that can be used to validate a given file

type MultipartStream

type MultipartStream = Readable & {
    headers: {
        [key: string]: string;
    };
    name: string;
    filename: string;
    bytes: number;
    file: MultipartFileContract;
};

Readable stream along with some extra data. This is what is passed to onFile handlers.

type PartHandler

type PartHandler = (
    part: MultipartStream,
    reportChunk: (chunk: Buffer) => void
) => Promise<
    | ({
          filePath?: string;
          tmpPath?: string;
      } & {
          [key: string]: any;
      })
    | void
>;

The callback handler for a given file part

namespace @ioc:Adonis/Core/Request

module '@ioc:Adonis/Core/Request' {}

Extending the request interface on the core module

interface RequestContract

interface RequestContract {}

property multipart

multipart: MultipartContract;

method allFiles

allFiles: () => {
    [field: string]: MultipartFileContract | MultipartFileContract[];
};

method file

file: (
    key: string,
    options?: Partial<FileValidationOptions>
) => MultipartFileContract | null;

method files

files: (
    key: string,
    options?: Partial<FileValidationOptions>
) => MultipartFileContract[];

Package Files (3)

Peer Dependencies (3)

@adonisjs/application
@adonisjs/drive
@adonisjs/http-server

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@adonisjs/bodyparser.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@adonisjs/bodyparser)

HTML

<a href="https://www.jsdocs.io/package/@adonisjs/bodyparser"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 7 months ago.
Package analyzed in 3345 ms.
Missing or incorrect documentation? Open an issue for this package.

@adonisjs/bodyparser

Install

Overview

Index

Classes

Namespaces

Classes

class BodyParserProvider

constructor

property app

property needsApplication

method boot

method register

Namespaces

namespace @ioc:Adonis/Core/BodyParser

variable BodyParserMiddleware

interface BodyParserMiddlewareContract

construct signature

interface MultipartContract

property state

method abort

method onFile

method process

interface MultipartFileContract

property allowedExtensions

property clientName

property errors

property extname

property fieldName

property fileName

property filePath

property hasErrors

property headers

property isMultipartFile

property isValid

property meta

property size

property sizeLimit

property state

property subtype

property tmpPath

property type

property validated

method markAsMoved

method move

method moveToDisk

method toJSON

method validate

type BodyParserConfig

type BodyParserFormConfig

type BodyParserJSONConfig

type BodyParserMultipartConfig

type BodyParserRawConfig

type FileJSON

type FileUploadError

type FileValidationOptions

type MultipartStream

type PartHandler

namespace @ioc:Adonis/Core/Request

interface RequestContract

property multipart

method allFiles

method file

method files

Package Files (3)

Dependencies (9)

Dev Dependencies (33)

Peer Dependencies (3)

Badge