基于 JSON-schema 规范,erschema-suite 是一个适用于前端开发的数据校验工具。它可以帮助开发者更加轻松地设计和验证前端表单等数据模型。
安装
我们可以通过 npm 包管理工具进行安装:
npm install erschema-suite
使用
首先我们需要初始化一个 erschema 实例,并进行相应配置,例如:
-- -------------------- ---- ------- ------ ---------- ---- ----------------- ----- ---------- - --- ---------- ----- --------- --------- -------- ------ ---------- ----------- - ----- - ----- --------- ---------- --- ---------- -- -- ---- - ----- --------- -------- --- -------- --- -- ------- - ----- --------- -------- ---------- -- -- ---
以上代码为我们定义了一个简单的用户信息数据模型对象,其中包括用户姓名、年龄和性别,分别对应字符串、数字和字符串类型,并包含相应的校验规则。
接下来我们可以使用 validate
方法进行数据校验,例如:
-- -------------------- ---- ------- ----- -------- - - ----- ------ ---- ---- ------- ---- -- ----- ------ - ------------------------------ -- -------------- - ---------------------- - ---- - --------------------------- -
上述代码中,我们将用户数据传入 userSchema.validate
方法中,该方法会对数据进行验证,并返回一个结果对象,其中的 valid
属性为 true
表示数据校验通过,否则会返回错误信息。
高级用法
erschema-suite 还支持更多功能和高级用法,可以应对更加复杂的应用场景。
自定义错误信息
我们可以通过定义自定义错误信息来对不能满足要求的数据进行详细的说明。例如:
-- -------------------- ---- ------- ----- ---------- - --- ---------- ----- --------- --------- -------- ------ ---------- ----------- - ----- - ----- --------- ---------- --- ---------- -- -- ---- - ----- --------- -------- --- -------- --- ------------- - ------- - ------------------------------------------------------------------------------ -------- ------------------------------------------------------------------------------------------------------------------------