简介
@skema/basic 是一个基于 TypeScript 编写的用于数据校验和转换的 JavaScript 库，它提供了程序化的方法来声明和验证数据模型，并且可以根据模型转换输入的数据。此外，它还支持异步验证和转换，可用于前端和后端。
安装
在项目中安装 @skema/basic，可以使用 npm 或 yarn。
npm install @skema/basic
或者
yarn add @skema/basic
安装完成后，你就可以在代码中使用它了。
基本用法
通过 @skema/basic 所提供的 API，我们可以定义一个数据模型，这个模型可以包含数据的类型、校验规则和转换规则。下面是一个简单的例子：
-- -------------------- ---- ------- ------ - ----- - ---- --------------- -- -------- ----- ----- - --- ------- ----- ------- ---- ------ --- -- ---- ----- ------------- - ---------------- ----- ------ ---- -- --- --------------------------- -- - ----- ------ ---- -- - -- ---- ----- ------------- - --------------- ----- -------- ---- ---- --- --------------------------- -- - ----- -------- ---- -- -展开代码
通过这个例子，我们可以看到 @skema/basic 的基本用法：首先，我们使用 Skema 实例来定义一个数据模型，然后使用 validate 和 convert 方法来校验和转换数据。
深入使用
除了基本用法外，@skema/basic 还提供了更多高级的特性。
自定义校验规则
@skema/basic 内置了许多校验规则，如 required、min、max 等，但是有时候我们可能需要自定义一些校验规则，这时候我们可以使用 rule 方法来定义一个自定义校验规则。下面是一个例子：
-- -------------------- ---- ------- ------ - ----- - ---- --------------- -- -------- ----- ----- - --- ------- ----- - ----- ------- --------- ----- ----- --- -- -------- --- -- -- ------- -- ---- ------- --- -- ---- ---------------- ----- ------ ---- -- --- -- -- ---------------- ----- -------- ---- -- --- -- ---------展开代码
异步校验和转换
有时候我们需要对请求数据进行异步的校验和转换操作，这时候我们可以使用 asyncRule 和 asyncTransform 方法，它们可以返回一个 Promise，用于异步操作。
-- -------------------- ---- ------- ------ - ----- - ---- --------------- -- -------- ----- ----- - --- ------- ----- - ----- ------- --------- ----- ---------- ----- --- -- - ------ --- ----------------- ------- -- - ------------- -- - -- -- --- ------ - ---------- - ---- - ------------ ------ -- ------ - -- ------ --- -- -- ---- ------- --- -- ------ ----- -------- -------------- - --- - ----- --- - ----- --------------------- ----- -------- ---- -- --- -- ---- ----------------- - ----- ----- - ----------------- - - ---------------展开代码
表单校验
在前端开发中，表单校验是非常常见的操作，@skema/basic 也提供了对表单校验的支持。
-- -------------------- ---- ------- ------ - ----- - ---- --------------- -- ------ ----- --------- - --- ------- --------- - ----- ------- --------- ----- -- --------- - ----- ------- --------- ----- ---- -- -- ---------------- - ----- ------- --------- ----- ---- -- ----- --- - -------- -- -- - --- --------- -- --- -- ---- ------------------------ --------- ------ --------- --------- ---------------- --------- ---展开代码
通过 validateForm 方法，我们可以对整个表单进行校验。
结语
@skema/basic 是一个非常实用的 JavaScript 库，它提供了丰富的数据校验和转换功能，可以帮助我们更方便地处理数据。本文介绍了 @skema/basic 的基本用法和深入使用，并提供了相应的示例代码，希望可以对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedc290b5cbfe1ea06120a9
