{"id":14989578,"url":"https://github.com/nashaofu/koa-parser","last_synced_at":"2025-04-12T01:40:41.516Z","repository":{"id":22465278,"uuid":"117094605","full_name":"nashaofu/koa-parser","owner":"nashaofu","description":"a body parser for koa","archived":false,"fork":false,"pushed_at":"2023-01-23T23:51:24.000Z","size":1411,"stargazers_count":4,"open_issues_count":12,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-14T08:33:43.810Z","etag":null,"topics":["body-parser","bodyparser","koa","koa-middleware","koa2","koajs"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nashaofu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-11T12:00:45.000Z","updated_at":"2023-04-18T02:20:07.000Z","dependencies_parsed_at":"2023-02-13T05:00:43.254Z","dependency_job_id":null,"html_url":"https://github.com/nashaofu/koa-parser","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nashaofu%2Fkoa-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nashaofu%2Fkoa-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nashaofu%2Fkoa-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nashaofu%2Fkoa-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nashaofu","download_url":"https://codeload.github.com/nashaofu/koa-parser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248505716,"owners_count":21115352,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["body-parser","bodyparser","koa","koa-middleware","koa2","koajs"],"created_at":"2024-09-24T14:18:35.886Z","updated_at":"2025-04-12T01:40:41.491Z","avatar_url":"https://github.com/nashaofu.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# koa-parser[![Build Status](https://travis-ci.org/nashaofu/koa-parser.svg?branch=master)](https://travis-ci.org/nashaofu/koa-parser)\na body parser for koa. support json, form(urlencoded), multipart and text type body.\n\n## Install\n\n[![NPM](https://nodei.co/npm/koa-parser.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/koa-parser/)\n\n## Usage\n\n```js\nconst Koa = require('koa')\nconst parser = require('koa-parser')\n\nconst port = 3000\nconst app = new Koa()\n\napp.use(parser())\n\napp.use(async (ctx, next) =\u003e {\n  // if nothing was parsed, body will be undefined\n  if (ctx.request.body !== undefined) {\n    ctx.body = ctx.request.body\n  }\n  await next()\n})\n\napp.listen(port)\nconsole.error(`listening on port ${port}`)\n```\n\n## Screenshot\n\n![default options](./screenshot/1.png)\n\n## Options\n\n```typescript\napp.use(parser({\n  encoding?: string, // requested encoding\n  error?: (err: any, ctx: Koa.Context) =\u003e any, // support custom parser error handle\n  json?: string | string[], // support json parser types\n  multipart?: string | string[], // support multipart(form-data) parser types\n  text?: string | string[], // support text parser types\n  urlencoded?: string | string[] // support urlencoded(form) parser types\n}))\n```\n\n* **encoding**: requested encoding. Default is ``utf-8``\n\n* **error**: support custom error handle, Default is ``false``. if koa-bodyparser throw an error, you can customize the response like:\n  ```js\n  app.use(parser({\n    error (err, ctx) {\n      console.log(err)\n      ctx.throw(err, 422)\n    }\n  }))\n  ```\n\n* **json**: Extended support for json parsing options, The default supported types are ``['application/json', 'application/json-patch+json', 'application/vnd.api+json', 'application/csp-report']``. you can customize the type like:\n  ```js\n  // json will be support default types and application/x-javascript\n  app.use(parser({\n    json: 'application/x-javascript' // You can also pass parameters in an array\n  }))\n  ```\n\n* **multipart**: Extended support for multipart(form-data) parsing options, The default supported types are ``['multipart/form-data']``\n\n* **text**: Extended support for text parsing options, The default supported types are ``['text/plain']``\n\n* **urlencoded**: Extended support for urlencoded(form) parsing options, The default supported types are ``['application/x-www-form-urlencoded']``\n\n## Licences\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnashaofu%2Fkoa-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnashaofu%2Fkoa-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnashaofu%2Fkoa-parser/lists"}