Lzh on GitHub

Valibot 目前可用于 Node、Bun 和 Deno。下面你将学习如何将该库添加到你的项目中。

通用

除了本指南，本文档其余部分假设你在代码示例中使用 npm 进行导入。

使用独立导入或通配符导入应该没有区别。在这两种情况下，摇树优化（Tree shaking）和代码分割（code splitting）都应该能正常工作。

如果你正在使用 TypeScript，我们建议你在 tsconfig.json 中启用严格模式，以便所有类型都能正确计算。

所需的最低 TypeScript 版本是 v5.0.2。

{
  "compilerOptions": {
    "strict": true,
    // ...
  }
}

从 npm 安装

对于 Node 和 Bun，你可以使用你喜欢的包管理器，通过一个简单的命令将该库添加到你的项目中。

npm install valibot     # npm
yarn add valibot        # yarn
pnpm add valibot        # pnpm
bun add valibot         # bun

然后，你可以在任何 JavaScript 或 TypeScript 文件中导入它。

// 使用独立导入
import { … } from 'valibot';

// 使用通配符导入
import * as v from 'valibot';

从 JSR 安装

对于 Node、Deno 和 Bun，你可以使用你喜欢的包管理器，通过一个简单的命令将该库添加到你的项目中。

deno add jsr:@valibot/valibot      # deno
npx jsr add @valibot/valibot       # npm
yarn dlx jsr add @valibot/valibot  # yarn
pnpm dlx jsr add @valibot/valibot  # pnpm
bunx jsr add @valibot/valibot      # bun

然后，你可以在任何 JavaScript 或 TypeScript 文件中导入它。

// 使用独立导入
import { … } from '@valibot/valibot';

// 使用通配符导入
import * as v from '@valibot/valibot';

在 Deno 中，你也可以使用 jsr: 指定符直接引用我。

// 使用独立导入
import { … } from 'jsr:@valibot/valibot';

// 使用通配符导入
import * as v from 'jsr:@valibot/valibot';

从 Deno 安装

对于 Deno，你可以直接通过我们的 deno.land/x URL 引用该库。

// 使用独立导入
import { … } from 'https://deno.land/x/valibot/mod.ts';

// 使用通配符导入
import * as v from 'https://deno.land/x/valibot/mod.ts';