Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/huisir001/koa-body-2
A Koa body parser middleware. Supports multipart, urlencoded and JSON request bodies.
https://github.com/huisir001/koa-body-2
Last synced: about 2 months ago
JSON representation
A Koa body parser middleware. Supports multipart, urlencoded and JSON request bodies.
- Host: GitHub
- URL: https://github.com/huisir001/koa-body-2
- Owner: huisir001
- License: mit
- Created: 2022-06-23T02:36:13.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-07-29T07:59:27.000Z (over 2 years ago)
- Last Synced: 2024-04-29T13:02:56.412Z (8 months ago)
- Language: TypeScript
- Size: 156 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# koa-body-2
> A full-featured [`koa`](https://github.com/koajs/koa) body parser middleware. Supports `multipart`, `urlencoded`, and `json` request bodies. Provides the same functionality as Express's bodyParser - [`multer`](https://github.com/expressjs/multer).
> Reference from [`koa-body`](https://github.com/koajs/koa-body), Improve the file upload mechanism, support custom storage of files, support unparsed file configuration, and make file upload more flexible.
## Install
>Install with [npm](https://github.com/npm/npm)
```
npm install koa-body-2
```
## Features
- can handle requests such as:
* **multipart/form-data**
* **application/x-www-form-urlencoded**
* **application/json**
* **application/json-patch+json**
* **application/vnd.api+json**
* **application/csp-report**
* **text/xml**
- option for patch to Koa or Node, or either
- file uploads
- body, fields and files size limiting
## Hello World - Quickstart
```sh
npm install koa koa-body-2 # Note that Koa requires Node.js 7.6.0+ for async/await support
```
Default file storage:
```js
import Koa from 'koa'
import koaBody2 from 'koa-body-2'
const app = new Koa();
app.use(koaBody2({multipart: true}));
app.use(ctx => {
ctx.body = `Request incoming: ${JSON.stringify({
body: ctx.request.body,
raw: ctx.request.raw,
files: ctx.request.files
})}`;
});
app.listen(8080);
```
Custom file storage:
```js
import Koa from 'koa'
import koaBody2 from 'koa-body-2'
import os from 'node:os'
import path from 'node:path'
import fs from 'node:fs'
const app = new Koa();
// config options
const koaBodyOpts = {
multipart: true,
multiOptions: {
fileParser: true, // if parse file
ifDIY: true,
// uploadDir: os.tmpdir(),
onFileBegin (ctx, fieldName, file, fileStream) {
return new Promise((resolve, reject) => {
// DIY file save
let _size = 0
if (fileStream) {
fileStream
// Listen for chunk flow
.on('data', (chunk) => {
_size += chunk.length
})
// Monitor write complete
.on('end', () => {
// File size calculation
const gb = Number((_size / 1024 / 1024 / 1024).toFixed(2)),
mb = Number((_size / 1024 / 1024).toFixed(2)),
kb = Number((_size / 1024).toFixed(2));
file.size = _size
file.unitSize = gb > 1 ? `${gb} GB` : mb > 1 ? `${mb} MB` : `${kb} KB`
})
const newName = file.hash + file.extName
const filepath = path.join(os.tmpdir(), newName)
// Create a write stream
// To distinguish between complete and incomplete files,
// use a new suffix here and wait for the file transfer to complete before renaming.
const tempPath = filepath + '.temp'
// Since file occupancy has a maximum (maximum number of files opened),
// you can consider using queues to control the number of WriteStream
// (skipped here for the time being)
const ws = fs.createWriteStream(tempPath)
// write
fileStream.pipe(ws)
.on('error', (err) => {
// If the write stream is not destroyed here, the file will be occupied and cannot be deleted.
ws.destroy()
// Handling error messages
// Transfer error directly delete cache file
fs.unlink(tempPath, (err) => {
if (err && err.errno != -4058) {
console.error(err)
}
})
reject(err)
})
.on('finish', () => {
// If the write stream is not destroyed here, the file will be occupied and cannot be rename.
ws.destroy()
// Rename and remove temp suffix
fs.rename(tempPath, filepath, (err) => {
if (err) {
reject(err)
} else {
file.newName = newName
file.path = filepath
// file.src =
file.lastModified = Date.now()
resolve(void 0)
}
})
})
// fileStream err
fileStream.on('error', (err) => {
// The write stream will not be actively closed and needs to be destroyed.
ws.destroy()
// Transfer error directly delete cache file
fs.unlink(tempPath, (err) => {
if (err && err.errno != -4058) {
console.error(err)
}
})
reject(err)
})
}
})
}
},
onError (err, ctx) {
console.error(err)
}
}
app.use(koaBody2(koaBodyOpts));
app.use(ctx => {
ctx.body = `Request incoming: ${JSON.stringify({
body: ctx.request.body,
raw: ctx.request.raw,
files: ctx.request.files
})}`;
});
app.listen(8080);
```
## Example
Default file storage:
```sh
cd example
node ex.js
```
Or custom file stream storage:
```sh
cd example
node ex1.js
```
Or custom file path:
```sh
cd example
node ex2.js
```
```sh
node index.js
curl -i http://localhost:3000/users -d "name=test"
```
Output:
```text
HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
Content-Length: 29
Date: Wed, 03 May 2017 02:09:44 GMT
Connection: keep-alive
Request incoming: {"body":{"name":"test"}}
```