{"id":15363843,"url":"https://github.com/chentsulin/koa-context-validator","last_synced_at":"2025-06-13T05:32:07.559Z","repository":{"id":8754347,"uuid":"59561765","full_name":"chentsulin/koa-context-validator","owner":"chentsulin","description":"A robust context validator for koajs. Use Joi behind the scenes.","archived":false,"fork":false,"pushed_at":"2024-11-18T23:20:25.000Z","size":1802,"stargazers_count":54,"open_issues_count":4,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-18T18:06:01.514Z","etag":null,"topics":["koa","middleware","validation"],"latest_commit_sha":null,"homepage":"","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/chentsulin.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-05-24T09:58:53.000Z","updated_at":"2024-06-18T06:00:35.000Z","dependencies_parsed_at":"2023-02-14T21:03:23.112Z","dependency_job_id":"e065302b-4b31-4d32-a72a-f350f304deff","html_url":"https://github.com/chentsulin/koa-context-validator","commit_stats":{"total_commits":91,"total_committers":5,"mean_commits":18.2,"dds":"0.31868131868131866","last_synced_commit":"97a71fa401413f43f4be5b8a1cdd589029894925"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/chentsulin/koa-context-validator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chentsulin%2Fkoa-context-validator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chentsulin%2Fkoa-context-validator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chentsulin%2Fkoa-context-validator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chentsulin%2Fkoa-context-validator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chentsulin","download_url":"https://codeload.github.com/chentsulin/koa-context-validator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chentsulin%2Fkoa-context-validator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259588915,"owners_count":22880870,"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":["koa","middleware","validation"],"created_at":"2024-10-01T13:08:44.298Z","updated_at":"2025-06-13T05:32:07.525Z","avatar_url":"https://github.com/chentsulin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# koa-context-validator\n\n[![npm version](https://badge.fury.io/js/koa-context-validator.svg)](https://npmjs.org/package/koa-context-validator)\n[![Build Status](https://github.com/chentsulin/koa-context-validator/workflows/CI/badge.svg?branch=master)](https://github.com/chentsulin/koa-context-validator/actions?query=branch%3Amaster)\n[![Coverage Status](https://coveralls.io/repos/github/chentsulin/koa-context-validator/badge.svg?branch=master)](https://coveralls.io/r/chentsulin/koa-context-validator?branch=master)\n\n\u003e A robust context validator for koajs. Use [`Joi`](https://github.com/sideway/joi) behind the scenes.\n\n## Installation\n\n```sh\n$ npm install koa-context-validator joi\n```\n\n## Usage\n\n### `query` Validation\n\n```js\nimport Koa from 'koa';\nimport validator, { Joi } from 'koa-context-validator';\n\nconst app = new Koa();\n\napp.use(\n  validator({\n    query: Joi.object().keys({\n      username: Joi.string().required(),\n    }),\n  }),\n);\n```\n\n### `body` Validation\n\n```js\nimport Koa from 'koa';\nimport bodyParser from 'koa-bodyparser';\nimport validator, { Joi } from 'koa-context-validator';\n\nconst app = new Koa();\n\napp.use(bodyParser());\napp.use(\n  validator({\n    body: Joi.object().keys({\n      username: Joi.string().required(),\n      age: Joi.number().required(),\n    }),\n  }),\n);\n```\n\n### `headers` Validation\n\n```js\nimport Koa from 'koa';\nimport validator, { Joi } from 'koa-context-validator';\n\nconst app = new Koa();\n\napp.use(\n  validator({\n    headers: Joi.object()\n      .keys({\n        username: Joi.string().required(),\n      })\n      .unknown(),\n  }),\n);\n```\n\n### With `koa-compose`\n\n```js\nimport Koa from 'koa';\nimport compose from 'koa-compose';\nimport validator, { Joi } from 'koa-context-validator';\n\nconst app = new Koa();\n\napp.use(\n  compose([\n    validator({\n      query: Joi.object().keys({\n        username: Joi.string().required(),\n      }),\n    }),\n    async (ctx) =\u003e {\n      ctx.body = ctx.request.query;\n    },\n  ]),\n);\n```\n\n### With `koa-mount`\n\n```js\nimport Koa from 'koa';\nimport mount from 'koa-mount';\nimport validator, { Joi } from 'koa-context-validator';\n\nconst app = new Koa();\n\napp.use(\n  mount(\n    '/api',\n    validator({\n      query: Joi.object().keys({\n        username: Joi.string().required(),\n      }),\n    }),\n  ),\n);\n```\n\n### With `@koa/router`\n\n```js\nimport Koa from 'koa';\nimport Router from '@koa/router';\nimport validator, { Joi } from 'koa-context-validator';\n\nconst router = new Router();\nrouter.get(\n  '/api/:username',\n  validator({\n    params: Joi.object().keys({\n      username: Joi.string().required(),\n    }),\n  }),\n  async (ctx) =\u003e {\n    ctx.body = ctx.params;\n  },\n);\n\nconst app = new Koa();\napp.use(router.middleware());\n```\n\n### With `options`\n\n```js\nimport Koa from 'koa';\nimport validator, { Joi } from 'koa-context-validator';\n\napp.use(\n  validator(\n    {\n      query: Joi.object().keys({\n        username: Joi.string().required(),\n      }),\n    },\n    {\n      abortEarly: true,\n      allowUnknown: false,\n      cache: true,\n      stripUnknown: true,\n      debug: false,\n    },\n  ),\n);\n```\n\n### Asynchronous Operations\n\n```js\nimport Koa from 'koa';\nimport validator, { Joi } from 'koa-context-validator';\n\nconst lookup = async (username) =\u003e {\n  const user = await db.get('user', username);\n  if (!user) {\n    throw new Error('Invalid username');\n  }\n};\n\napp.use(\n  validator({\n    body: Joi.object().keys({\n      username: Joi.string().external(lookup),\n    }),\n  }),\n);\n```\n\n### With `Joi.ref`\n\n```js\nimport Koa from 'koa';\nimport validator, { Joi } from 'koa-context-validator';\n\napp.use(\n  validator({\n    body: Joi.object().keys({\n      username: Joi.string().default(Joi.ref('$defaultUsername')),\n      age: Joi.number().default(Joi.ref('$defaultAge')),\n    }),\n  }),\n);\n```\n\n## Koa 1.x\n\nUse `convert.back` from `koa-convert`.\n\n```js\nimport koa from 'koa'; // koa 1.x\nimport convert from 'koa-convert';\nimport validator, { Joi } from 'koa-context-validator';\n\nconst app = koa();\n\napp.use(\n  convert.back(\n    validator({\n      query: Joi.object().keys({\n        username: Joi.string().required(),\n      }),\n    }),\n  ),\n);\n```\n\n## API\n\n### validator(schema, options?)\n\n#### schema\n\n_Required_\nType: `object`\n\nA object which has optional `query`, `body`, `headers` and `params` schema to validate.\n\n#### options\n\nJust be passed to Joi's validate function as options:\n\nhttps://joi.dev/api/?v=17.4.2#anyvalidatevalue-options\n\n### Joi\n\nThe `Joi` object from the [joi](https://github.com/sideway/joi) package.\n\n## TypeScript\n\nAs of version 1.0.0 we've added initial support for TypeScript.\n\n## License\n\nMIT © [C.T. Lin](https://github.com/chentsulin/koa-context-validator)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchentsulin%2Fkoa-context-validator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchentsulin%2Fkoa-context-validator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchentsulin%2Fkoa-context-validator/lists"}