前言
在前端开发中，有时需要自动生成测试数据或者填充一些虚拟数据。而手动编写测试数据过于繁琐且易错，这时候就需要使用工具自动填充数据了。今天我们要介绍的是 @gik/tools-populator 这个 npm 包，它是一个轻量级的数据填充工具，可以快速、简单地生成各种类型的数据。
安装
安装 @gik/tools-populator 非常简单，只需要在终端中执行以下命令：
$ npm install @gik/tools-populator
使用示例
我们先看一个简单的示例：
-- -------------------- ---- ------- ----- - --- - - -------------------------------- ----- ---------- - - ----- - ----- ----------- -- ---- - ----- ---------- ------ ---- --- -- ------ - ----- ------- -- -- ----- ---- - --------------- --- ------------------
这个示例中，我们通过 gen 函数生成了 5 条数据，数据的结构在 dataSchema 中定义。其中 dataSchema 中的每个属性都对应一个数据类型，例如 name 表示姓名，类型为 firstName；age 表示年龄，类型为 integer；email 表示邮箱，类型为 email。
生成的示例数据如下：
[
{ "name": "Leon", "age": 48, "email": "pgjobf@geosx.bg" },
{ "name": "Carl", "age": 22, "email": "dc@vtc.sn" },
{ "name": "Jessica", "age": 49, "email": "uojdqny@ufw.af" },
{ "name": "Joan", "age": 40, "email": "qxuw@ppc.lt" },
{ "name": "Amanda", "age": 47, "email": "ljlwbvze@ci.tv" }
]这里只是一个简单的示例，下面让我们深入了解 @gik/tools-populator 的各项功能。
API
gen(schema, count)
schema: 数据结构定义count: 生成数据的数量，必填
gen 函数是本包的核心，用于生成数据。它接受两个参数：
schema，结构体定义。它是一个对象，用于定义数据的类型和结构。对象中的每个属性对应一种数据类型，值为包含数据类型、range 和其他配置项的对象。具体可以参考下一节的类型列表。count，生成数据的数量。如果不传这个参数，生成的数据数组中就只包含一个数据对象，否则就生成指定数量的数据对象。
下面是一个包含多个数据类型定义的示例：
-- -------------------- ---- -------
----- - --- - - --------------------------------
----- ---------- - -
--- - ----- ------ --
----- - ----- ----------- --
-------- - ----- ---------- --
------- - ----- ----------- ------ ---- ------- ---- ------- ----- --
---- - ----- ---------- ------ ---- --- --
------ - ----- ------- --
-------- -
----- ----------
------------ -----
------------- ----
--
------ - ----- ------- ------ -------------- ------------- --
--------- - ----- --------- --
-------- - ----- -------- ------ ----- ------ ------ - --
-------------- - ----- ------- -
--
----- ---- - --------------- ---
------------------生成的示例数据如下：
-- -------------------- ---- -------
- -
----- ---------------------------------------
------- ---------
---------- ---------
--------- ------------------------------------
------ ---
-------- ----------------
---------- -----------------------------
-------- ---------------------------
----------- ------
---------- --------
---------------- ---------
-- -
----- ---------------------------------------
------- ------------
---------- -----------
--------- ------------------------------------
------ ---
-------- -----------
---------- -------------------------
-------- ---------------------------
----------- -----
---------- --------
---------------- ---------
-- -
----- ---------------------------------------
------- --------
---------- --------
--------- ------------------------------------
------ ---
-------- -------------------
---------- ------------------
-------- ---------------------------
----------- ------
---------- -------
---------------- ---------
-- -
----- ---------------------------------------
------- -----------
---------- ---------
--------- ------------------------------------
------ ---
-------- -----------------
---------- ---------------------
-------- ---------------------------
----------- ------
---------- -------
---------------- ---------
-- -
----- ---------------------------------------
------- ------------
---------- ----------
--------- ------------------------------------
------ ---
-------- --------------------
---------- ----------------------
-------- ---------------------------
----------- -----
---------- -------
---------------- ---------
- -数据类型列表
@gik/tools-populator 支持生成多种数据类型，以下是支持的数据类型列表及其配置：
- uuid: UUID 字符串。
format: 格式化形式，可取default（8-4-4-4-12）或short（8-4-4）。
- integer: 整数。
range: 范围，如[1, 10]，默认为[0, 100]。
- float: 浮点数，可设置小数位数量。
range: 范围，如[1, 10]，默认为[0, 100]。fixed: 限制小数点后的位数，如2，默认为undefined。
- date: 时间，可设置范围。
range: 范围，如['2000-01-01', '2050-12-30']。
- color: 随机颜色，返回 RGB16 进制字符串。
- firstName: 第一个名字，如 'John'。
- lastName: 姓，如 'Doe'。
- fullName: 姓名，如 'John Doe'。
- email: 邮箱地址。
- phone: 电话号码。
- zip: 邮政编码。
- address: 地址。
inclDetails: 是否包括详细地址，如 ‘No. 12, Street, City, PO.Box’。useShortName: 是否使用缩写，如省份缩写，区名缩写。
- imageUrl: 图像 URL。
width: 宽度，如100，默认为200。height: 高度，如100，默认为200。format: 图片格式，如jpg，默认为png。
总结
本文介绍了 @gik/tools-populator 这个 npm 包的使用方法，并提供了多个数据类型的示例。这个包非常轻量级，但是提供了很多方便快捷的方法，可以很方便地生成各种类型的测试数据。同时，包的使用方法也非常简单，只需要在终端中执行安装命令后，即可在代码中调用相关函数生成数据。希望这篇文章能够帮助到前端开发者更快地生成测试数据。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005668881e8991b448e2c33