# @fastify/formbody

> A module for Fastify to parse x-www-form-urlencoded bodies

Latest version **9.0.0** (published 2026-08-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @fastify/formbody
pnpm add @fastify/formbody
yarn add @fastify/formbody
bun add @fastify/formbody
```

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 9.0.0 |
| Published | 2026-08-08 |
| First published | 2022-04-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 16.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 137 |
| Author | James Sumners |
| Maintainers | matteo.collina, eomm, kibertoad, climba03003, gurgunday, tony133, fdawgs |
| Keywords | fastify, x-www-form-urlencoded |

## Links

- npm: https://www.npmjs.com/package/@fastify/formbody
- Repository: https://github.com/fastify/fastify-formbody
- Homepage: https://github.com/fastify/fastify-formbody#readme
- Issues: https://github.com/fastify/fastify-formbody/issues
- Funding: https://github.com/sponsors/fastify
- npm.io page: https://npm.io/package/@fastify/formbody

## Dependencies (2)

- [fastify-plugin](https://npm.io/package/fastify-plugin.md) ^6.0.0
- [fast-querystring](https://npm.io/package/fast-querystring.md) ^1.1.2

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 9.0.0 (latest) — 2026-08-08
- 8.0.0 (next) — 2024-09-05
- 8.0.2 — 2025-01-10
- 8.0.1 — 2024-09-22
- 8.0.0-pre.fv5.3 — 2024-08-07
- 8.0.0-pre.fv5.2 — 2024-07-18
- 8.0.0-pre.fv5.1 — 2024-07-18
- 7.4.0 — 2022-12-04
- 7.3.0 — 2022-09-19
- 7.2.0 — 2022-09-07
- 7.1.0 — 2022-08-26
- 7.0.1 — 2022-05-24
- 7.0.0 — 2022-05-10
- 6.0.1 — 2022-05-10
- 6.0.0 — 2022-04-27

## README

# @fastify/formbody

[![CI](https://github.com/fastify/fastify-formbody/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fastify/fastify-formbody/actions/workflows/ci.yml)
[![NPM version](https://img.shields.io/npm/v/@fastify/formbody.svg?style=flat)](https://www.npmjs.com/package/@fastify/formbody)
[![NPM downloads](https://img.shields.io/npm/dm/fastify-formbody.svg?style=flat)](https://www.npmjs.com/package/@fastify/formbody)
[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)

A simple plugin for [Fastify][fastify] that adds a content type parser for
the content type `application/x-www-form-urlencoded`.

[fastify]: https://fastify.dev/

## Install

```
npm i @fastify/formbody
```


### Compatibility
| Plugin version | Fastify version |
| ---------------|-----------------|
| `^8.x`         | `^5.x`          |
| `^7.x`         | `^4.x`          |
| `^6.x`         | `^3.x`          |
| `^3.x`         | `^2.x`          |
| `^2.x`         | `^1.x`          |


Please note that if a Fastify version is out of support, then so are the corresponding versions of this plugin
in the table above.
See [Fastify's LTS policy](https://github.com/fastify/fastify/blob/main/docs/Reference/LTS.md) for more details.

## Example

Given the following code:

```js
const fastify = require('fastify')()

fastify.register(require('@fastify/formbody'))

fastify.post('/', (req, reply) => {
  reply.send(req.body)
})

fastify.listen({ port: 8000 }, (err) => {
  if (err) throw err
})
```

And a `POST` body of:

```html
foo=foo&bar=bar&answer=42
```

The sent reply would be the object:

```js
{
  foo: 'foo',
  bar: 'bar',
  answer: 42
}
```

## Options

The plugin accepts an options object with the following properties:

+ `bodyLimit`: The maximum amount of bytes to process
before returning an error. If the limit is exceeded, a `500` error will be
returned immediately. When set to `undefined` the limit will be set to whatever
is configured on the parent Fastify instance. The default value is
whatever is configured in
[fastify](https://github.com/fastify/fastify/blob/main/docs/Reference/Server.md#bodylimit)
 (`1048576` by default).
+ `parser`: The default parser used is the querystring.parse built-in.  You can change this default by passing a parser function e.g. `fastify.register(require('@fastify/formbody'), { parser: str => myParser(str) })`

## Upgrading from 4.x

Previously, the external [qs lib](https://github.com/ljharb/qs) was used that did things like parse nested objects. For example:

- ***Input:*** `foo[one]=foo&foo[two]=bar`
- ***Parsed:*** `{ foo: { one: 'foo', two: 'bar' } }`

The way this is handled now using the built-in querystring.parse:

- ***Input:*** `foo[one]=foo&foo[two]=bar`
- ***Parsed:*** `{ 'foo[one]': 'foo', 'foo[two]': 'bar' }`

If you need nested parsing, you must configure it manually by installing the qs lib (`npm i qs`), and then configure an optional parser:

```js
const fastify = require('fastify')()
const qs = require('qs')
fastify.register(require('@fastify/formbody'), { parser: str => qs.parse(str) })
```

## License

Licensed under [MIT](./LICENSE).

---
_Source: https://npm.io/package/@fastify/formbody · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._