@types/body-parser

What is @types/body-parser?

The @types/body-parser package contains TypeScript definitions for the body-parser package. Body-parser is a middleware used in Express applications to parse incoming request bodies before your handlers, available under the req.body property. It supports parsing of JSON, raw, text, and URL-encoded form bodies. The @types/body-parser package doesn't provide functionality by itself but offers type definitions to enable TypeScript developers to use body-parser in a type-safe manner.

What are @types/body-parser's main functionalities?

JSON Body Parsing

Parses incoming request bodies in a middleware before your handlers, available under the req.body property, assuming the Content-Type header of the request is application/json.

import * as bodyParser from 'body-parser';
import express from 'express';

const app = express();

app.use(bodyParser.json());

app.post('/json', (req, res) => {
  res.send(req.body);
});

URL-Encoded Form Body Parsing

Parses incoming request bodies with URL-encoded data (like form submissions) before your handlers, making the form data available under the req.body property.

import * as bodyParser from 'body-parser';
import express from 'express';

const app = express();

app.use(bodyParser.urlencoded({ extended: true }));

app.post('/form', (req, res) => {
  res.send(req.body);
});

0

README

Installation

npm install --save @types/body-parser

Summary

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

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/body-parser.

Additional Details

• Last updated: Tue, 06 Jul 2021 18:05:43 GMT
• Dependencies: @types/connect, @types/node
• Global values: none

Credits

These definitions were written by Santi Albo, Vilic Vane, Jonathan Häberle, Gevik Babakhani, Tomasz Łaziuk, Jason Walton, and Piotr Błażejewicz.