Installations

npm install koa-get-body

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

7.7.3

NPM Version

5.2.0 Score

68.5

Supply Chain

83

Quality

75.1

Maintenance

50

Vulnerability

99.6

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

1

JavaScript

JavaScript (100%)

Developer

yangg

Download Statistics

Total Downloads

7,650

Last Day

1

Last Week

6

Last Month

29

Last Year

425

GitHub Statistics

2 Stars

11 Commits

1 Watchers

1 Branches

1 Contributors

Updated on Jan 27, 2023

Bundle Size

538.64 kB

Minified

195.06 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

View All 1 Contributors

Package Meta Information

Latest Version

1.1.2

Package Id

koa-get-body@1.1.2

Size

3.40 kB

NPM Version

5.2.0

Node Version

7.7.3

Total Downloads

Cumulative downloads

Total Downloads

7,650

Last Day

0%

1

Compared to previous day

Last Week

100%

6

Compared to previous week

Last Month

-37%

29

Compared to previous month

Last Year

8.7%

425

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

busboy

Dev Dependencies

4

jasmine koa supertest xml2js

koa-get-body

A body parser for koa2, support urlencoded, multipart， json，text and xml(need option xmlParser configured). (return raw body for non-supported mime types)

Installation

1npm install koa-get-body

Usage

1const Koa = require('koa')
2const getBody = require('koa-get-body')
3
4let app = new Koa()
5app.use(getBody())
6app.use(async ctx => {
7  const body = await ctx.request.getBody()
8  // or get a single field
9  const name = await ctx.request.getBody('name')
10})

Custom Options

1app.use(getBody({
2  alias: 'getPost', // alias func name on `ctx',
3  uploadDir: '/path/to/your/dir/',
4  xmlParser: utils.paserXML, // see https://github.com/yangg/koa-get-body/blob/master/spec/utils.js
5  getFileName: (fieldName) => {
6    return shortid.generate()
7  },
8  limits: {
9    fileSize: Infinity,
10    // ...
11  }
12}))
13app.use(async ctx => {
14  const body = await ctx.getPost() // get body via alias `getPost'
15})

Options

alias - {string}, append an alias to koa ctx, then you can use ctx.aliasName()
jsonTypes - {array|string}, types to detect as json, see type-is, default: ['json', '+json'], the following mime types will matched: application/json, application/vnd.api+json, application/json-patch+json
textTypes - {array|string}, types to detect as text, default: text/*
xmlTypes - {array|string}, types to detect as xml, default: xml
xmlParser - {function}, a function to parse xml if you needed
uploadDir - {string}, custom upload dir, default to os.tmpdir()
getFileName - {function}, generate upload temp filename in you own way
more options: see Busboy options

TODO

add support for array or object fieldNames ([] or [name])

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.3

/10

Last Scanned on 2025-06-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More