Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional extended

extended: boolean

The extended option allows to choose between parsing the URL-encoded data with the querystring library (when false) or the qs library (when true).

Optional inflate

inflate: boolean

When set to true, then deflated (compressed) bodies will be inflated; when false, deflated bodies are rejected. Defaults to true.

Optional limit

limit: string | number

Controls the maximum request body size. If this is a number, then the value specifies the number of bytes; if it is a string, the value is passed to the bytes library for parsing. Defaults to '100kb'.

Optional parameterLimit

parameterLimit: number

The parameterLimit option controls the maximum number of parameters that are allowed in the URL-encoded data. If a request contains more parameters than this value, a 413 will be returned to the client. Defaults to 1000.

Optional type

type: string | string[] | ((req: IncomingMessage) => any)

The type option is used to determine what media type the middleware will parse

Methods

Optional verify

  • The verify option, if supplied, is called as verify(req, res, buf, encoding), where buf is a Buffer of the raw request body and encoding is the encoding of the request.

    Parameters

    Returns void