Interface BodyParserOptions

Hierarchy

  • BodyParserOptions

Properties

detectJSON? enable? enableTypes? encoding? extendTypes? formLimit? jsonLimit? onerror? strict? textLimit? xmlLimit?

Properties

Optional detectJSON

detectJSON?: ((ctx: IMidwayKoaContext) => boolean)

Type declaration

Optional enable

enable?: boolean

Optional enableTypes

enableTypes?: string[]

parser will only parse when request type hits enableTypes, default is ['json', 'form'].

Optional encoding

encoding?: string

requested encoding. Default is utf-8 by co-body

Optional extendTypes

extendTypes?: {
    form?: string | string[];
    json?: string | string[];
    text?: string | string[];
}

support extend types

Type declaration

  • Optional form?: string | string[]
  • Optional json?: string | string[]
  • Optional text?: string | string[]

Optional formLimit

formLimit?: string

limit of the urlencoded body. If the body ends up being larger than this limit a 413 error code is returned. Default is 56kb

Optional jsonLimit

jsonLimit?: string

limit of the json body. Default is 1mb

Optional onerror

onerror?: ((err: Error, ctx: IMidwayKoaContext) => void)

Type declaration

Optional strict

strict?: boolean

when set to true, JSON parser will only accept arrays and objects. Default is true

Optional textLimit

textLimit?: string

limit of the text body. Default is 1mb.

Optional xmlLimit

xmlLimit?: string

limit of the xml body. Default is 1mb.

Settings

Member Visibility

Theme

Generated using TypeDoc