npm 包 @steedos/standard-objects 使用教程

介绍

@steedos/standard-objects 是一款基于 Node.js 平台的 npm 包,能够帮助前端开发者更加方便地使用标准业务对象。该包中预置了许多业务对象模板,开发者只需要根据实际场景进行二次开发即可快速构建出符合自己需求的业务对象。

安装

在终端执行以下命令进行安装:

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

使用教程

引用模块

在项目中使用该模块时,需要先引用模块,如下所示:

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

创建业务对象

创建业务对象需要使用 create 方法,如下所示:

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

以上示例中,object_name 为业务对象的名称,object_label 为业务对象的标签。

fields 数组中为当前业务对象预置的字段,其中:

  • fieldApiName: 字段的 API 名称,必须唯一。

  • fieldType: 字段的类型,支持的类型如下表所示:

    类型 描述
    text 文本类型,支持文本、数字和日期类型的字段
    email 电子邮件类型
    phone 电话号码类型
    url URL 类型
    picklist 下拉列表类型,支持单选列表和多选列表,需要在 picklistOptions 属性中添加选项值
    checkbox 复选框类型,只能取值 truefalse
    lookup 查找类型,支持关联其他业务对象或系统用户。
  • label: 字段的标签名称。

  • defaultValue: 字段默认值。

  • maxLength: 字段最大长度。

  • required: 字段是否必填。

  • unique: 字段是否唯一。

除了 fields 之外,还可以添加其他配置项:

  • description: 对象的描述信息。
  • icon_name: 对象图标名称。
  • enable_bulk_api: 是否开启批量 API。
  • enable_change_log: 是否启用数据变更记录。

添加记录

在业务对象创建完成并进行配置之后,就可以往对象中添加新的记录了,如下所示:

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

其中,field_api_name 为业务对象中的字段 API 名称,field_value 为该字段对应的值。

查询记录

从业务对象中查询记录时,可以使用 find 方法,如下所示:

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

其中,filter 用于设置查询条件,limit 用于限制返回结果的数量,sort 用于设置排序方式。

修改记录

要修改业务对象中的现有记录,需要使用 update 方法,如下所示:

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

其中,record._id 为需要修改的记录 ID。

删除记录

要从业务对象中删除记录,可以使用 remove 方法,如下所示:

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

其中,record._id 为需要删除的记录 ID。

示例代码

下面是一个完整的示例代码,实现了一个简单的任务管理系统:

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

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

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

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

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

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

总结

通过以上使用教程和示例代码,相信读者已经掌握了 npm 包 @steedos/standard-objects 的使用方法。该包能够帮助开发者快速构建出符合自己需求的业务对象,提高开发效率。如果您在使用过程中遇到了问题,欢迎在下方评论区留言,笔者会及时回复。

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


猜你喜欢

  • npm 包 @ltd/j-toml 使用教程

    简介 @ltd/j-toml 是一个用于解析 TOML 格式文件的 npm 包。TOML 是一种简单的配置文件格式,类似于 JSON 或 YAML,但更简洁易读。@ltd/j-toml 软件包由 li...

    5 年前
  • npm 包 @iarna/standard 的使用教程

    在前端开发中,我们经常需要使用一些代码规范工具来提高我们的代码质量和可维护性。而在这些工具中,@iarna/standard 是一个不错的选择,它是一个基于 ESLint 的 JavaScript 代...

    5 年前
  • npm 包 @evocateur/libnpmpublish 使用教程

    前言 在前端开发中,我们常常需要借助 npm 包来快速实现功能。而有时,我们需要自己创建一个 npm 包,供其他开发者使用。在这种情况下,@evocateur/libnpmpublish 可以帮助我们...

    5 年前
  • npm 包 @0x-lerna-fork/collect-uncommitted 使用教程

    前言 在进行前端开发过程中,我们难免会遇到要将一些不同的代码段整合到一起的问题,这时我们就会需要一个工具来帮助我们分析并集合这些代码。本文将介绍一个名为 @0x-lerna-fork/collect-...

    5 年前
  • npm 包 @0x-lerna-fork/run 使用教程

    如果您是前端开发者,肯定会使用一些工具来帮助开发和测试,npm 就是这样一个非常重要的工具。在开发应用程序时,我们需要一个可靠和强大的构建系统,因此选用合适的 npm 包,可以大大提高我们的开发效率。

    5 年前
  • npm 包 @0x-lerna-fork/list 使用教程

    在前端开发中,我们会用到各种各样的 npm 包来帮助我们快速地实现功能以及优化我们的项目。其中一个比较实用的 npm 包是 @0x-lerna-fork/list,这个包提供了一些常用的数组操作以及一...

    5 年前
  • npm 包 @0x-lerna-fork/init 使用教程

    前言 随着前端技术的不断发展,前端工程化的重要性日益凸显,而 Lerna 是一个优秀的针对大型多包管理的工具。而 @0x-lerna-fork/init 是一个基于 Lerna 二次封装的 NPM 包...

    5 年前
  • npm 包 @0x-lerna-fork/import 使用教程

    前言 在现代 Web 开发中,使用第三方的开源工具和库是很常见的一件事情。而 npm 作为一个 Node.js 的包管理器,是我们经常使用的一个工具。其中,@0x-lerna-fork/import ...

    5 年前
  • npm 包 @0x-lerna-fork/exec 使用教程

    介绍 @0x-lerna-fork/exec 是一个 Node.js 模块,用于在 Node.js 中运行子进程的命令并获取它们的输出。这个命令是 Lerna 的分支版本,由 0x 团队维护并改进,是...

    5 年前
  • npm 包 @0x-lerna-fork/diff 使用教程

    简介 @0x-lerna-fork/diff 是一个开源的 npm 包,用于比较两个 JavaScript 对象的差异。它是基于 diff 和 deep-diff 两个包开发的,可以用于前端、后端等各...

    5 年前
  • npm 包 @0x-lerna-fork/clean 使用教程

    在前端开发中,我们常常需要使用各种 npm 包来辅助我们完成任务。其中,一个非常实用的 npm 包是 @0x-lerna-fork/clean。该 npm 包可以帮助我们清理项目中的一些冗余文件,以提...

    5 年前
  • npm 包 @0x-lerna-fork/add 使用教程

    前言 在前端开发中,npm 管理包已经成为非常常见的方式之一。通过使用 npm 包,我们可以方便地引入第三方库,提高开发效率。本文将介绍一个使用 npm 包 @0x-lerna-fork/add 的方...

    5 年前
  • npm包 @0x-lerna-fork/global-options 使用教程

    前言 在前端开发中,我们经常使用npm包来完成一些开发工作。而@0x-lerna-fork/global-options是一个非常实用的npm包,它可以帮助我们更加便捷地处理命令行参数,加快应用程序的...

    5 年前
  • npm 包 infer-owner 使用教程

    在前端开发中,我们经常会使用各类的 npm 包来辅助开发,管理这些包是一件非常重要的事情。infer-owner 是一款可以帮助我们确定一个 npm 包的所有者的工具,今天就来介绍一下它的使用方法。

    5 年前
  • npm 包 @evocateur/npm-registry-fetch 使用教程

    介绍 npm 是 Node.js 生态系统中的包管理工具,方便开发者快速下载、安装、管理和发布 JavaScript 代码等多种类型的包,让开发过程更加便捷和高效。

    5 年前
  • npm 包 @0x-lerna-fork/run-topologically 使用教程

    如果你经常使用 npm,那么你一定知道它极其重要。npm 包是开发前端项目时必不可少的工具之一。本文将介绍一个叫做 @0x-lerna-fork/run-topologically 的 npm 包。

    5 年前
  • npm 包 @0x-lerna-fork/prompt 使用教程

    npm 是 Node.js 的官方包管理器,其丰富的包库可以满足前端开发所需的任何依赖。但是,随着依赖包的增加,越来越多的 Front-End 开发者有了碎片化的开发体验。

    5 年前
  • npm 包 @0x-lerna-fork/prerelease-id-from-version 使用教程

    简介 npm 包 @0x-lerna-fork/prerelease-id-from-version 是一个用于获取预发行版本的 id 的 JavaScript 工具,针对的是语义化版本(SemVer...

    5 年前
  • npm包 @0x-lerna-fork/gitlab-client的使用教程

    简介 在前端开发中,我们经常需要使用GitLab进行代码管理。@0x-lerna-fork/gitlab-client是一个npm包,提供了一系列Api,使得在前端项目中使用GitLab变得更加方便快...

    5 年前
  • npm 包 @0x-lerna-fork/github-client 使用教程

    简介 在前端开发过程中,经常需要操作 Github API 进行代码托管、版本管理等。为了更加便捷地使用 Github API ,@0x-lerna-fork/github-client 库应运而生。

    5 年前

相关推荐

    暂无文章