npm 包 Uran 使用教程

NPM(Node Package Manager)是 Node.js 的包管理工具,这里介绍一款在前端开发中很常用的 npm 包 —— Uran。Uran 是一款轻量级的表单数据验证工具,它支持异步验证,多种内置的验证规则,并且扩展性也很强。

安装

可以使用 NPM 进行 Uran 的安装:

--- - ----

安装完之后,就可以在项目中使用 Uran 了。

基本使用

导入 Ural

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

设置验证规则

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

这里我们定义了两个规则,email 和 password。email 需要满足必填和邮箱格式的要求,password 需要满足必填和最小长度为6的要求。

创建 Uran 实例

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

创建 Uran 实例后,就可以在表单中使用它进行验证了。

调用 validate 方法验证数据

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

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

调用 validate 方法验证数据时,需要传入需要验证的数据和一个回调函数。回调函数中会返回验证结果。如果验证通过,则 errors 参数为 null 或 undefined。

异步验证

如果需要异步验证,可以使用 Promise:

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

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

在这个示例中,我们在 setTimeout 中模拟了一秒钟的异步请求,然后再调用 validate 方法进行验证。

高级用法

使用自定义规则

Uran 可以简单的定义自己的验证规则,只需将下面简单的验证函数添加到规则中即可。

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

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

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

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

在这个示例中,我们创建了一个自定义的规则 custom_rule,它的 validator 函数的返回值必须为 true 才算验证通过,否则会返回一个 message。

自定义错误消息

在 rules 中定义规则时,可以设置一个 messages 字段,用于自定义错误提示消息。messages 字段是一个对象,其中 key 为字段名,value 为一个对象,包含每个验证规则的错误提示信息。

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

在这个示例中,我们设置了两个字段 email 和 password 的错误提示信息,分别对应了 email 和 password 的所有验证规则。

结论

在前端开发中,表单数据验证是必不可少的。Uran 轻量且易于使用,还具有高度的可扩展性。通过此篇文章的介绍,你已经可以开始使用 Uran 进行表单数据验证了。同时,Uran 源码开放,如果需要更多的扩展,可以自行对 Uran 进行二次开发。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005665781e8991b448e27bc


猜你喜欢

  • npm 包 gentle-proxy-synchronized 使用教程

    在前端项目开发中,代理服务器是一个非常常见的使用场景。通过代理服务器,我们可以实现让前端请求到自己本机以外的服务器,让前端请求到自己本机以外的 API 接口,方便我们的项目开发并且提升项目的灵活度。

    3 年前
  • npm 包 ng5-gallery 使用教程

    如何在你的 Angular5+ 应用程序中使用 ng5-gallery 包并构建美观的图库。在本文中,我们将学习如何在 Angular5+ 项目中使用 ng5-gallery 包来建立一个逼真的图片浏...

    3 年前
  • npm 包 `mk-app-visit-widget` 使用教程

    在前端开发中,我们经常需要使用一些第三方的包来实现各种功能。而 npm 就是目前最流行的包管理器之一,提供了海量的第三方包供我们使用。其中,mk-app-visit-widget 就是一款非常实用的前...

    3 年前
  • npm 包 StrangerStrings 使用教程

    前言 在前端开发中,我们经常要用到字符串的处理,包括截取、替换、查找等等。这个时候,我们可能需要自己写一些函数来处理字符串,但是这样会浪费不少时间。幸运的是,现在有许多优秀的 npm 包可以帮我们轻松...

    3 年前
  • npm 包 pexi 使用教程

    介绍 Pexi 是一个轻量级的 React 组件库,它提供了一系列常用的 UI 组件,包括按钮、输入框、下拉框、表格等等。Pexi 使用了最新的 React Hooks 技术,能够帮助开发者快速构建高...

    3 年前
  • npm 包 pixi-dust 使用教程

    Pixi-dust 是一个基于 Pixi.js 的粒子引擎。它可以帮助我们快速、简单地创建复杂的粒子效果,让页面效果更加美观、生动。本文将介绍如何使用 npm 包 pixi-dust 创建粒子效果。

    3 年前
  • npm 包 pixi-game-utilities 使用教程

    Pixi.js 是一个专注于 2D 渲染的高效画布库,是目前前端开发中常用于开发游戏、动画等的一个强大工具。而 pixi-game-utilities 这个 npm 包则是用于提高 Pixi.js 开...

    3 年前
  • npm 包 pixi-charm 使用教程

    在前端开发中,我们常常需要使用到绘图库,而 Pixi.js 是一个极为流行的 2D 游戏和绘图库。在 Pixi.js 的基础上,pixi-charm 通过封装一系列动画和粒子效果,提供了更丰富多样的元...

    3 年前
  • npm 包 pixi-smoothie 使用教程

    Pixi.js 是一款强大的 2D 渲染引擎,广泛应用于游戏开发和交互式应用程序开发。Pixi-smoothie 是 Pixi.js 的插件之一,它提供了一种简单的方式来在 Pixi.js 中添加一个...

    3 年前
  • npm 包 pixi-sprite-utilities 使用教程

    如果你正在开发基于 PixiJS 的前端项目,那么 pixi-sprite-utilities 可能会成为你的得力助手。pixi-sprite-utilities 是一个便捷的 npm 包,它提供了一...

    3 年前
  • npm 包 pixi-tile-utilities 使用教程

    简介 pixi-tile-utilities 是一个可以帮助我们更加方便地在 PIXI.js 中创建和使用平铺地图以及瓷砖图的工具。这个 npm 包支持两种主要的用法: 创建和管理平铺地图 创建和使...

    3 年前
  • npm 包 bindreduxstoretodom 使用教程

    在前端开发中,使用 npm 包来处理不同的任务已经很普遍了。其中一个非常有用的 npm 包是 bindreduxstoretodom,它可以将 Redux store 中的数据绑定到 HTML 元素上...

    3 年前
  • npm包database-rik使用教程

    在现代的web开发中,后端数据库成为了不可或缺的一部分,而在前端领域中也有许多的需求需要与数据库进行互动,例如在复杂的Web应用程序中,需要处理数据并将其存储在可靠的数据存储库中。

    3 年前
  • npm 包 bpnp 使用教程

    什么是 bpnp bpnp 是一款基于 Vue.js 的前端 UI 组件库,提供了丰富的 UI 组件和交互效果,在日常的前端开发中使用非常方便。 如何安装 bpnp 使用 npm 安装 bpnp 十分...

    3 年前
  • npm 包 @headforwards-spd/aws-lambda 使用教程

    简介 npm 包 @headforwards-spd/aws-lambda 是一个用于封装 AWS Lambda 函数的 Node.js 包。它可以帮助开发者更加方便地在 AWS Lambda 上运行...

    3 年前
  • npm包deep-equal-nonrecursive使用教程

    在web开发中,我们经常需要判断两个对象是否相等。而Javascript中的相等判断有时会有一些问题,这就需要使用一些工具来帮助我们进行正确的相等判断。在本文中,我们将介绍如何使用一个npm包——de...

    3 年前
  • npm 包 @headforwards-spd/aws-dynamo 使用教程

    在前端开发中,经常需要使用到数据存储的功能。AWS DynamoDB 是一种高性能、灵活可扩展的 NoSQL 数据库服务。本文主要介绍如何使用 @headforwards-spd/aws-dynamo...

    3 年前
  • npm 包 memorija 使用教程

    简介 memorija 是一个能够简化前端应用中状态管理的 npm 包。它提供了一种灵活、简洁的方式来管理 React 应用中的状态,并且能够让开发者更容易地在应用程序中进行状态管理。

    3 年前
  • npm 包 react-enable-select-file 使用教程

    在前端开发过程中,文件上传和文件选择是一项非常常见的功能。但是,HTML 的 input 元素默认的样式和布局可能无法满足实际项目的需要。因此,我们需要使用一些现成的工具来帮助我们实现这些功能。

    3 年前
  • npm 包 files-generator 使用教程

    前端开发中,文件生成是一项非常重要的任务。典型的例子是在构建应用程序时生成配置文件、生成组件样板、生成模型定义、生成程序入口等等。此时,npm 包 files-generator 就是一个非常好用的工...

    3 年前

相关推荐

    暂无文章