# @eggjs/ajv-plugin > ajv plugin for egg and tegg Latest version **4.1.0** (published 2026-10-07) · 0 weekly downloads ## Install ```sh npm install @eggjs/ajv-plugin pnpm add @eggjs/ajv-plugin yarn add @eggjs/ajv-plugin bun add @eggjs/ajv-plugin ``` ## Health **Score 70/100 (B)** — status: active. Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 4.1.0 | | Published | 2026-10-07 | | First published | 2025-10-23 | | Weekly downloads | 0 | | TypeScript types | bundled | | Module format | ESM | | Node | >=22.18.0 | | Dependencies | 6 | | Unpacked size | 8.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | Maintainers | gxkl, eggjs-admin, fengmk2, atian25, hyj1991, killagu, coolme200, akitasummer, elrrrrrrr, niania | | Keywords | ajv, egg, module, plugin, tegg, typescript | ## Links - npm: https://www.npmjs.com/package/@eggjs/ajv-plugin - Repository: https://github.com/eggjs/egg - Homepage: https://github.com/eggjs/egg/tree/next/tegg/plugin/ajv - Issues: https://github.com/eggjs/egg/issues - npm.io page: https://npm.io/package/@eggjs/ajv-plugin ## Dependencies (6) - [ajv](https://npm.io/package/ajv.md) ^8.8.2 - [@eggjs/lifecycle](https://npm.io/package/@eggjs/lifecycle.md) 4.1.0 - [@eggjs/ajv-formats](https://npm.io/package/@eggjs/ajv-formats.md) ^3.0.1 - [@eggjs/ajv-keywords](https://npm.io/package/@eggjs/ajv-keywords.md) ^5.1.0 - [@eggjs/ajv-decorator](https://npm.io/package/@eggjs/ajv-decorator.md) 4.1.0 - [@eggjs/core-decorator](https://npm.io/package/@eggjs/core-decorator.md) 4.1.0 ## Alternatives - [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads - [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads - [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads - [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads - [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads ## Recent versions - 4.1.0 (latest) — 2026-10-07 - 4.0.2-rc.1 (rc) — 2026-10-06 - 4.0.2-beta.27 (beta) — 2026-09-20 - 4.0.2 — 2026-10-06 - 4.0.2-rc.0 — 2026-09-23 - 4.0.2-beta.26 — 2026-08-07 - 4.0.2-beta.25 — 2026-07-13 - 4.0.2-beta.24 — 2026-07-12 - 4.0.2-beta.23 — 2026-07-11 - 4.0.2-beta.22 — 2026-07-11 - 4.0.2-beta.20 — 2026-07-09 - 4.0.2-beta.19 — 2026-06-29 - 4.0.2-beta.17 — 2026-06-28 - 4.0.2-beta.16 — 2026-06-26 - 4.0.2-beta.15 — 2026-06-26 - … 24 more at https://npm.io/package/@eggjs/ajv-plugin/versions ## README # @eggjs/ajv-plugin [![NPM version][npm-image]][npm-url] [![Known Vulnerabilities][snyk-image]][snyk-url] [![npm download][download-image]][download-url] [![Node.js Version](https://img.shields.io/node/v/@eggjs/ajv-plugin.svg?style=flat)](https://nodejs.org/en/download/) [npm-image]: https://img.shields.io/npm/v/@eggjs/ajv-plugin.svg?style=flat-square [npm-url]: https://npmjs.org/package/@eggjs/ajv-plugin [snyk-image]: https://snyk.io/test/npm/@eggjs/ajv-plugin/badge.svg?style-square [snyk-url]: https://snyk.io/test/npm/@eggjs/ajv-plugin [download-image]: https://img.shields.io/npm/dm/@eggjs/ajv-plugin.svg?style-square [download-url]: https://npmjs.org/package/@eggjs/ajv-plugin 参考 [@eggjs/typebox-validate](https://github.com/eggjs/egg/tree/next/plugins/typebox-validate) 的最佳实践，结合 ajv + typebox，只需要定义一次参数类型和规则，就能同时拥有参数校验和类型定义（完整的 ts 类型提示）。 ## egg 模式 ### Install ```shell # tegg 注解 npm i --save @eggjs/tegg # tegg 插件 npm i --save @eggjs/tegg-plugin # tegg ajv 插件 npm i --save @eggjs/ajv-plugin ``` ### Prepare ```json // tsconfig.json { "extends": "@eggjs/tsconfig" } ``` ### Config ```js // config/plugin.js exports.tegg = { package: '@eggjs/tegg-plugin', enable: true, }; exports.teggAjv = { package: '@eggjs/ajv-plugin', enable: true, }; ``` ## standalone 模式 ### Install ```shell # tegg 注解 npm i --save @eggjs/tegg # tegg ajv 插件 npm i --save @eggjs/ajv-plugin ``` ### Prepare ```json // tsconfig.json { "extends": "@eggjs/tsconfig" } ``` ## Usage 1、定义入参校验 Schema 使用 typebox 定义，会内置到 tegg 导出 ```ts import { Type, TransformEnum } from '@eggjs/tegg/ajv'; const SyncPackageTaskSchema = Type.Object({ fullname: Type.String({ transform: [TransformEnum.trim], maxLength: 100, }), tips: Type.String({ transform: [TransformEnum.trim], maxLength: 1024, }), skipDependencies: Type.Boolean(), syncDownloadData: Type.Boolean(), // force sync immediately, only allow by admin force: Type.Boolean(), // sync history version forceSyncHistory: Type.Boolean(), // source registry registryName: Type.Optional(Type.String()), }); ``` 2、从校验 Schema 生成静态的入参类型 ```ts import { Static } from '@eggjs/tegg/ajv'; type SyncPackageTaskType = Static; ``` 3、在 Controller 中使用入参类型和校验 Schema 注入全局单例 ajv，调用 `ajv.validate(XxxSchema, params)` 进行参数校验，参数校验失败会直接抛出 `AjvInvalidParamError` 异常， tegg 会自动返回相应的错误响应给客户端。 ```ts import { Inject, HTTPController, HTTPMethod, HTTPMethodEnum, HTTPBody } from '@eggjs/tegg'; import { Ajv, Type, Static, TransformEnum } from '@eggjs/tegg/ajv'; const SyncPackageTaskSchema = Type.Object({ fullname: Type.String({ transform: [TransformEnum.trim], maxLength: 100, }), tips: Type.String({ transform: [TransformEnum.trim], maxLength: 1024, }), skipDependencies: Type.Boolean(), syncDownloadData: Type.Boolean(), // force sync immediately, only allow by admin force: Type.Boolean(), // sync history version forceSyncHistory: Type.Boolean(), // source registry registryName: Type.Optional(Type.String()), }); type SyncPackageTaskType = Static; @HTTPController() export class HelloController { private readonly ajv: Ajv; @HTTPMethod({ method: HTTPMethodEnum.POST, path: '/sync', }) async sync(@HTTPBody() task: SyncPackageTaskType) { this.ajv.validate(SyncPackageTaskSchema, task); return { task, }; } } ``` --- _Source: https://npm.io/package/@eggjs/ajv-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._