npm 包 @skema/basic 使用教程

简介

@skema/basic 是一个基于 TypeScript 编写的用于数据校验和转换的 JavaScript 库,它提供了程序化的方法来声明和验证数据模型,并且可以根据模型转换输入的数据。此外,它还支持异步验证和转换,可用于前端和后端。

安装

在项目中安装 @skema/basic,可以使用 npm 或 yarn。

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

或者

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

安装完成后,你就可以在代码中使用它了。

基本用法

通过 @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


猜你喜欢

  • npm 包 @tunnckocore/git-semver-tags 使用教程

    什么是 @tunnckocore/git-semver-tags @tunnckocore/git-semver-tags 是一个 npm 包,可以用于获取 Git 仓库中按照语义化版本规范(semv...

    4 年前
  • npm包mentions-regex使用教程

    介绍 npm包mentions-regex是一个用于识别文本中@mention(@某人)的JavaScript模块。它提供了一个简单易用的正则表达式,可以用于从文本中提取出@mentions。

    4 年前
  • npm 包 collect-mentions 使用教程

    在前端开发中,我们经常需要对文本内容进行分析和处理,特别是在社交网络、博客和评论系统等场景下。其中,对于文本中 @ 提到的用户以及 # 热门话题的获取就是一项常见任务。

    4 年前
  • npm 包 parse-commit-message 使用教程

    随着 Web 应用的日益复杂和变化,前端开发的重要性和复杂性也在增加。在这样的环境中,npm 包的使用和管理则成为了前端开发中不可避免的一部分。本文将介绍一个 npm 包的使用教程——parse-co...

    4 年前
  • npm 包 git-commits-since 使用教程

    在前端开发的日常工作中,我们经常需要查看某个 git 仓库在某个时间点以后的提交记录。这个过程可以通过使用 git 命令行工具,并结合一些参数进行操作。但是,对于那些对命令行不熟悉或是想要更方便的方式...

    4 年前
  • npm 包 @standard-release/cli 使用教程

    在前端开发中,我们经常需要把代码发布到 npm 上供他人使用。由于发布的代码需要遵循一定的标准,因此我们需要引入一些工具来辅助我们进行版本发布。@standard-release/cli 就是为了解决...

    4 年前
  • npm 包 @tunnckocore/config 使用教程

    简介 在前端开发中,通常需要使用一些配置文件,例如应用的基础配置、环境变量、数据库连接等。npm 包 @tunnckocore/config 就是一个方便管理配置文件的工具,对于前端开发来说是非常实用...

    4 年前
  • npm 包 @tunnckocore/execa 使用教程

    介绍 @tunnckocore/execa 是一款基于 Node.js 的跨平台命令行操作工具,其核心功能是封装和执行系统命令、Shell 脚本和 Node.js 模块等操作,并能方便地获取命令执行的...

    4 年前
  • npm 包 json-6 使用教程

    在前端开发中,我们经常需要进行 JSON 数据的处理和传输。而 json-6 是一个在 JSON 基础上扩展了更多功能的 npm 包,可以更好的满足我们的需求。 本文将为大家详细介绍 json-6 的...

    4 年前
  • npm 包 @tunnckocore/pretty-config 使用教程

    简介 在前端开发过程中,我们通常需要使用配置文件来指定一些特定的参数或者选项,以便我们能够在代码中快速访问和修改它们。然而,在处理配置文件时,我们通常会遇到各种问题,比如说格式不正确、缺少关键字、没有...

    4 年前
  • npm 包 vdom-query 使用教程

    介绍 在前端开发中,DOM 操作是一个常见的任务,而 Virtual DOM(虚拟 DOM)是 Vue、React 等前端框架中常用的一种优化方式。vdom-query 是一个 npm 包,它提供了一...

    4 年前
  • npm 包 metro-symbolicate 使用教程

    在开发 React Native 应用时,我们经常会遇到程序崩溃的情况。这时候我们通常会需要查看崩溃日志,然后根据日志定位到代码中的问题。而在日志中,我们看到的通常只是一些奇怪的符号,这时候就需要使用...

    4 年前
  • npm 包 ob1 使用教程

    介绍 在前端开发中,我们常常需要进行一些数字类型的操作,例如加减乘除、比较大小等。但是,由于 JavaScript 中对数字类型的处理存在精度问题,可能会导致计算结果不准确。

    4 年前
  • npm 包 jest-preset-stylelint 使用教程

    在前端开发中,我们常常需要写单元测试来确保我们的代码符合预期。而 Jest 是一个非常流行的 JavaScript 测试框架,它可以运行在 Node.js 环境中,支持简单易用的语法,同时能够很好地集...

    4 年前
  • npm 包 prettier-config-hudochenkov 使用教程

    前言 在编写前端代码的过程中,我们经常会遇到代码格式化的问题。不同的开发者有不同的编码风格,代码格式化统一变得非常重要。Prettier 是一款流行的代码格式化工具,它可以帮助开发者快速准确地格式化代...

    4 年前
  • npm 包 @gitbook/slate-debug 使用教程

    前言 在前端开发的过程中,我们通常需要用到各种开源的第三方库和框架。这些库和框架能帮助我们快速地开发出高品质的网站和应用程序。其中,npm 是一个非常流行的包管理器,我们可以轻松地使用 npm 安装和...

    4 年前
  • npm 包 @gitbook/slate-schema-violations 使用教程

    简介 @gitbook/slate-schema-violations 是一个基于 Slate 的 npm 包,用于在编辑富文本内容时验证输入内容是否符合指定的 schema,从而保证文本内容的正确性...

    4 年前
  • npm 包 esrever 使用教程

    前言 在前端开发过程中,经常需要对字符串进行操作,其中涉及到的字符串是需要进行编码和反编码的。其中,在 JavaScript 中提供了常用的 encodeURI() 和 decodeURI() 方法,...

    4 年前
  • npm 包 immutablejs-record-memoize 使用教程

    随着前端应用程序越来越复杂,数据的管理也变得越来越重要。在 React 应用程序中,数据的不可变性越来越受到关注。Immutable.js 是一个非常流行的库,它提供了一种不可变的数据结构,可以帮助我...

    4 年前
  • npm 包 @gitbook/slate 使用教程

    简介 @gitbook/slate 是一个基于 React 和 Immutable.js 构建的富文本编辑器。该编辑器与常用的富文本编辑器不同在于其内部数据不是 HTML,而是经过格式化处理的 JSO...

    4 年前

相关推荐

    暂无文章