@ack_inc/utils 中文文档教程

Question

node-utils

我发现自己在多个项目中需要的一组实用函数

函数可以像这样单独需要：const fn = require('@ack_inc/utils/lib/')

Docs

generateRandomString(nChars, constraints)

生成一个长度为 nChars 的字符串，满足 constraints

用例：密码或临时令牌生成

Parameters

Name	Type	Required?	Description	Default	Comments
nChars	number	Y	The length of the string to generate		Must be a whole number.
constraints	object	N	Object specifying what characters can be in the generated string.	{}

constraints可能有以下键：

Key	Type	Effect
lowercase	Boolean	If true, include lowercase characters
uppercase	Boolean	If true, include uppercase chracters
digits	Boolean	If true, include digits
symbols	Boolean	If true, include symbols

如果 constraints 没有以上键，则假定允许所有字符

在 lib/generate-random-string.js 中查找使用的符号的完整列表 将

Return value

Type	Description
string	The random string

Usage

const { generateRandomString: rsg } = require('@ack_inc/utils');
console.log(rsg(<anything but a whole number>)); //=> throws TypeError
console.log(rsg(0)); //=> ""
console.log(rsg(5)); //=> "3`8aE"
console.log(rsg(5, { lowercase: true })); //=> "fewjk"
console.log(rsg(5, { lowercase: true, uppercase: true, digits: true, symbols: true })); //=> "%q31G"

---

groupByMultiKeys(records, getKeys)

记录数组分组为记录子数组的数组。 如果 getKeys 生成的任何键 === 相等，则记录进入同一个子数组（“组”）

用例：您有一个记录数组（比如人）； 记录来自多个来源，如果几个不同的“标识符”（电子邮件、电话号码、社交媒体句柄等）中的任何一个匹配，您想要合并记录（属于同一个人）。

Parameters

Name	Type	Required?	Description	Default	Comments
records	Array\	Y	Array of records to group		A TypeError is thrown if records is not an array with at least one element
getKeys	Function	Y	Function to generate keys for each record		Should take a record as the sole param, and return a single key or array of keys; signature is getKeys(record: object): Array<T>

Return value

Type	Description
Array\>	Each element of the returned array is a group of records for which at least one key matched

情况可能并非如此一组中的所有记录都有一个公共密钥。 此外，组中可能有两个记录没有共同的密钥。 例如，下面的三个记录将在同一组中，通过 A 和 C 没有公共键，因为它们与另一条记录有一个公共键在组中：

• Record A with keys ['a', 'b']
• Record B with keys ['b', 'c']
• Record C with keys ['c', 'd']

Usage

查看lib/group-by-multi-keys.test.js中的测试使用示例

---

formatMobileNumber(mobileNumber, formatString)

以不同方式格式化手机号码（必须包括国家代码）

Parameters

Name	Type	Required?	Description	Default	Comments
mobileNumber	string	Y	The mobile number to be formatted		An error is thrown if mobileNumber does not contain country code
formatString	string	N	String describing how the provided mobile number should be formatted	"+CASR"

在formatString< ，只有以下字符将被转换：

Character	Transformed into
C	country code
A	area code (first 3 digits after country code)
S	subscriber number (next 3 digits)
R	remaining digits

任何其他字符将原样出现在返回

Return value

Type	Description
string	The formatted mobile number

Usage

const { formatMobileNumber: format } = require('@ack_inc/utils');
console.log(format(<anything but a mobile number with country code>)); //=> throws Error

const mobile = "+1 123 456 7890";
expect(format(mobile)).toEqual("+11234567890");
expect(format(mobile, "+CASR")).toEqual("+11234567890");
expect(format(mobile, "+C A S R")).toEqual("+1 123 456 7890");
expect(format(mobile, "+C (A) S-R")).toEqual("+1 (123) 456-7890");

---

buildArr(n, generatorFn)

中

Parameters

Name	Type	Required?	Description	Default	Comments
n	number	Y	The number of elements in the created array
generatorFn	function	N	Function that controls the values of the elements in the created array	x => x

Return value

Type	Description
array	The built array

Usage

const { buildArr } = require('@ack_inc/utils');

expect(buildArr(0)).toEqual([]);
expect(buildArr(2)).toEqual([0, 1]);
expect(buildArr(2, idx => idx + 1)).toEqual([1, 2]);

To Do

• 的

• /code >

• 字符串 ：白名单字符

• 约束：黑名单字符

• 约束：可以作为 url 组件一部分的符号（参见 SO answer）