Installation

npm install --save @types/koa-bodyparser

Summary

This package contains type definitions for koa-bodyparser (https://github.com/koajs/body-parser).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/koa-bodyparser.

index.d.ts

// Type definitions for koa-bodyparser 4.3
// Project: https://github.com/koajs/body-parser
// Definitions by: Jerry Chin <https://github.com/hellopao>
//                 Hiroshi Ioka <https://github.com/hirochachacha>
//                 Alexi Maschas <https://github.com/amaschas>
//                 Pirasis Leelatanon <https://github.com/1pete>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

/* =================== USAGE ===================

    import bodyParser = require("koa-bodyparser");
    var Koa = require('koa');

    var app = new Koa();
    app.use(bodyParser());

 =============================================== */

import * as Koa from "koa";

declare module "koa" {
    interface Request {
        body?: any;
        rawBody: string;
    }
}

declare function bodyParser(opts?: bodyParser.Options): Koa.Middleware;

declare namespace bodyParser {
    interface Options {
        /**
         *  parser will only parse when request type hits enableTypes, default is ['json', 'form'].
         */
        enableTypes?: string[] | undefined;

        /**
         * requested encoding. Default is utf-8 by co-body
         */
        encode?: string | undefined;

        /**
         * limit of the urlencoded body. If the body ends up being larger than this limit
         * a 413 error code is returned. Default is 56kb
         */
        formLimit?: string | undefined;

        /**
         * limit of the json body. Default is 1mb
         */
        jsonLimit?: string | undefined;

        /**
         * limit of the text body. Default is 1mb.
         */
        textLimit?: string | undefined;

        /**
         * limit of the xml body. Default is 1mb.
         */
        xmlLimit?: string | undefined;

        /**
         * when set to true, JSON parser will only accept arrays and objects. Default is true
         */
        strict?: boolean | undefined;

        /**
         * custom json request detect function. Default is null
         */
        detectJSON?: ((ctx: Koa.Context) => boolean) | undefined;

        /**
         * support extend types
         */
        extendTypes?: {
            json?: string[] | undefined;
            form?: string[] | undefined;
            text?: string[] | undefined;
        } | undefined;

        /**
         * support custom error handle
         */
        onerror?: ((err: Error, ctx: Koa.Context) => void) | undefined;
    }
}

export = bodyParser;

Additional Details

Last updated: Thu, 23 Dec 2021 23:34:59 GMT
Dependencies: @types/koa
Global values: none

Credits

These definitions were written by Jerry Chin, Hiroshi Ioka, Alexi Maschas, and Pirasis Leelatanon.

Current Tags

30 Versions

4.3.5 ... 4 years ago
4.3.4 ... 4 years ago
4.3.3 ... 5 years ago
4.3.2 ... 5 years ago
4.3.1 ... 5 years ago
4.3.0 ... 7 years ago
4.2.2 ... 7 years ago
4.2.1 ... 7 years ago
5.0.2 ... 7 years ago
5.0.1 ... 8 years ago
5.0.0 ... 8 years ago
4.2.0 ... 8 years ago
3.0.26 ... 8 years ago
3.0.25 ... 9 years ago
3.0.24 ... 9 years ago
3.0.23 ... 9 years ago
3.0.22 ... 9 years ago
3.0.21 ... 9 years ago
3.0.20 ... 10 years ago
3.0.19 ... 10 years ago
3.0.18 ... 10 years ago
3.0.17-alpha ... 10 years ago
3.0.16-alpha ... 10 years ago
3.0.15-alpha ... 10 years ago
3.0.14-alpha ... 10 years ago
3.0.13-alpha ... 10 years ago
3.0.12-alpha ... 10 years ago
3.0.11-alpha ... 10 years ago
3.0.6-alpha ... 10 years ago
3.0.5-alpha ... 10 years ago