npm 包 okey 使用教程

阅读时长 4 分钟读完

概述

okey 是一个在 Node.js 环境下使用的基于 Promise 的验证器库。可以用来方便地进行各种表单验证,支持异步验证和自定义验证器等功能。在前端开发中,经常需要对表单数据进行验证,可以使用 okey 来简化这个过程,提高开发效率。

安装

使用 npm 安装 okey:

使用方法

  1. 引入 okey
  1. 创建一个验证函数

以上代码创建了一个验证函数,用于验证一个对象,对象的结构为 {name: string, age: number, email: string},验证规则分别对应:

  • name 字段:不能为空字符串,长度在 3 到 50 之间;
  • age 字段:必须为数字,且在 18 到 99 之间;
  • email 字段:必须为合法的邮箱格式。

可以根据实际需求自定义验证规则。

  1. 对对象进行验证
-- -------------------- ---- -------
----------
  ----- -------
  ---- ---
  ------ ------------------
---------- -- -
  ----------------------
----------------- -- -
  ----------------------- --------
---

在以上代码中,我们对一个对象进行了验证,验证通过时输出 '对象验证通过',验证失败时输出错误信息。

示例代码

-- -------------------- ---- -------
----- ---- - ----------------

-- ----------------- -------
-------------------------- ------- -- ----- --- -------- ---- ----------

----- -------- - ------
  ----- ----------------------------------------------------
  ---- ------------------------------
  ------ ------------------------
  --------- -----------------------------------------
  ---------- -----------------------------------------------------------
---

----------
  ----- -------
  ---- ---
  ------ -------------------
  --------- ---------
  ---------- ---------
---------- -- -
  ----------------------
----------------- -- -
  ----------------------- --------
---

在以上代码中,我们自定义了一个验证器 hello,用于验证一个字符串是否为 'hello'。然后创建了一个验证函数,用于验证一个对象,对象的结构为:

验证规则分别对应:

  • name 字段:不能为空字符串,长度在 3 到 50 之间;
  • age 字段:必须为数字,且在 18 到 99 之间;
  • email 字段:必须为合法的邮箱格式;
  • password 字段:长度在 6 到 20 之间;
  • password2 字段:必须和 password 字段相等。

当验证时传入的参数中 passwordpassword2 不相等时,会输出 '对象验证不通过:',并给出错误信息 '两次输入的密码不一致'

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066fac3d1de16d83a671e7

纠错
反馈