介绍
@steedos/standard-objects 是一款基于 Node.js 平台的 npm 包，能够帮助前端开发者更加方便地使用标准业务对象。该包中预置了许多业务对象模板，开发者只需要根据实际场景进行二次开发即可快速构建出符合自己需求的业务对象。
安装
在终端执行以下命令进行安装：
npm install @steedos/standard-objects
使用教程
引用模块
在项目中使用该模块时，需要先引用模块，如下所示：
const standardObjects = require('@steedos/standard-objects')();创建业务对象
创建业务对象需要使用 create 方法，如下所示：
-- -------------------- ---- -------
----- ------ - ----- ------------------------------------- --------------- -
------- -
-
------------- -----------------
---------- -------
------ --------------
------------- ---
---------- ----
--------- -----
------- -----
-
-- ---------
--
-- ----------
---以上示例中，object_name 为业务对象的名称，object_label 为业务对象的标签。
fields 数组中为当前业务对象预置的字段，其中：
fieldApiName: 字段的 API 名称，必须唯一。fieldType: 字段的类型，支持的类型如下表所示：类型 描述 text 文本类型，支持文本、数字和日期类型的字段 email 电子邮件类型 phone 电话号码类型 url URL 类型 picklist 下拉列表类型，支持单选列表和多选列表，需要在 picklistOptions属性中添加选项值checkbox 复选框类型，只能取值 true或falselookup 查找类型，支持关联其他业务对象或系统用户。 label: 字段的标签名称。defaultValue: 字段默认值。maxLength: 字段最大长度。required: 字段是否必填。unique: 字段是否唯一。
除了 fields 之外，还可以添加其他配置项：
description: 对象的描述信息。icon_name: 对象图标名称。enable_bulk_api: 是否开启批量 API。enable_change_log: 是否启用数据变更记录。
添加记录
在业务对象创建完成并进行配置之后，就可以往对象中添加新的记录了，如下所示：
const record = await object.save({
field_api_name: 'field_value'
// 在此处添加更多字段
});其中，field_api_name 为业务对象中的字段 API 名称，field_value 为该字段对应的值。
查询记录
从业务对象中查询记录时，可以使用 find 方法，如下所示：
-- -------------------- ---- -------
----- ------- - ----- -------------
------- -
--------------- -------------
-- -----------
--
------ ---
----- -
--------------- ----- -- ---- ----- -- ------
-- -----------
-
---其中，filter 用于设置查询条件，limit 用于限制返回结果的数量，sort 用于设置排序方式。
修改记录
要修改业务对象中的现有记录，需要使用 update 方法，如下所示：
await object.update(record._id, {
field_api_name: 'new_field_value'
// 在此处添加更多字段
});其中，record._id 为需要修改的记录 ID。
删除记录
要从业务对象中删除记录，可以使用 remove 方法，如下所示：
await object.remove(record._id);
其中，record._id 为需要删除的记录 ID。
示例代码
下面是一个完整的示例代码，实现了一个简单的任务管理系统：
-- -------------------- ---- -------
----- --------------- - ---------------------------------------
-- ------
----- ---------- - ----- ------------------------------ ----- -
------- -
-
------------- -------
---------- -------
------ -------
------------- ---
---------- ----
--------- -----
------- -----
--
-
------------- --------------
---------- -------
------ -------
------------- ---
---------- -----
--------- ------
------- -----
--
-
------------- -----------
---------- -----------
------ ------
------------- ---------
---------- ----
--------- -----
------- ------
---------------- -
- ------ --------- ------ ---- --
- ------ ------- ------ --- --
- ------ --------- ------ ---- -
-
--
-
------------- ---------
---------- -----------
------ -----
------------- ------
---------- ----
--------- -----
------- ------
---------------- -
- ------ ------ ------ ---- --
- ------ -------------- ------ ----- --
- ------ ------------ ------ ----- -
-
-
--
------------------ ----
---
-- -----
----- ------- - ----- -----------------
----- -------
------------ ------- - --------
--------- -------
------- -----
---
-- ------
----- -------- - ----- -----------------
------- -
--------- ------
--
------ ---
----- -
----------- -----
-
---
-- ----
----- ------------------------------ -
------------ ------- - -------
---
-- ----
----- -------------------------------总结
通过以上使用教程和示例代码，相信读者已经掌握了 npm 包 @steedos/standard-objects 的使用方法。该包能够帮助开发者快速构建出符合自己需求的业务对象，提高开发效率。如果您在使用过程中遇到了问题，欢迎在下方评论区留言，笔者会及时回复。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/205758