简介
@mariusc23/micro-schema
是一个用于 JavaScript 应用程序中执行数据验证的 npm 包。它可以用于检查来自 API 端点、文件上传、表单提交或其他任何需要验证输入的场景中的数据。该包提供了一种用于定义对象和数组中值的验证规则的简洁方式。
安装
你可以通过 npm 安装 @mariusc23/micro-schema
。在安装之前,你需要先安装 Node.js 环境和 npm 依赖管理工具。执行以下命令即可安装:
--- ------- -----------------------
用法示例
首先,我们需要从 @mariusc23/micro-schema
中导入 createSchema
方法并调用它来创建一个数据验证的实例:
----- - ------------ - - ----------------------------------- ----- ------ - -------------- --------- - ----- --------- --------- ---- -- ------ - ----- --------- --------- ---- -- --------- - ----- --------- --------- ----- ---------- - -- ---- - ----- -------- -- ---
以上代码定义了一个数据验证的实例 schema
,其中有四个属性,分别是 username
、email
、password
和 age
,具体验证规则如下:
username
和email
属性均为字符串类型,且必填。password
属性也为字符串类型,并且长度不能小于 6,必填。age
属性为数字类型,可选。
我们可以使用 schema.validate()
方法将数据与验证规则比较并获取检验结果:
----- ------ - ----------------- --------- ------ ------ ------------------ --------- --------- ---- --- ---
返回的结果是一个对象,包括两个属性:
isValid
:表示输入数据是否符合验证规则,如果isValid
为true
,则表示数据合法;如果为false
,则表示数据不合法。errors
:如果验证不通过,将返回一个数组,其中包含所有数据字段验证失败的消息。
现在让我们来测试一下:
-- ---------------- - ----------------------- - ---- - ------------------------ --------------- -
这将输出以下内容:
-------
验证规则选项
@mariusc23/micro-schema
模块支持的验证规则选项如下:
type
:值可以是'string'
、'number'
、'boolean'
、'array'
或'object'
,表示要验证的值的类型。如果不提供此选项,则在验证时假定类型正确。required
:如果设置为true
,则验证过程中此值是必需的。minLength
/maxLength
:字符串或数组的长度必须在指定的范围内。min
/max
:数字必须在指定的范围内。oneOf
:值必须是给定的数组中的一个值。
结论
在这篇文章中,我们已经介绍了如何使用 @mariusc23/micro-schema
进行数据验证。学习了这个包的用法,我们可以轻松地验证 API 接口收到的数据、前端表单提交数据的格式等。同时,这个包也带有一些可自定义的选项,希望你用起来都比较顺利,让你的前端开发事半功倍!
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005630381e8991b448e0de2