其他工具 (Misc)

这一节介绍了其他未被归类的内置工具函数。

字符串操作

capitalize(source)

• source: string 源文本
• 返回值: string 首字母大写后的文本

首字母大写。

camelCase(source)

• source: any 要转换的内容
• 返回值: any 转换结果

如果输入的是字符串，则将字符串转换成 camelCase；如果是数组或对象，则递归地将对象中的每个（可枚举）的键转换成 camelCase；其他情况不受影响。

paramCase(source)

如果输入的是字符串，则将字符串转换成 param-case；如果是数组或对象，则递归地将对象中的每个（可枚举）的键转换成 param-case；其他情况不受影响。

• source: any 要转换的内容
• 返回值: any 转换结果

snakeCase(source)

• source: any 要转换的内容
• 返回值: any 转换结果

如果输入的是字符串，则将字符串转换成 snake_case；如果是数组或对象，则递归地将对象中的每个（可枚举）的键转换成 snake_case；其他情况不受影响。

集合操作

contain(array1, array2)

• array1: readonly any[] 数组 1
• array2: readonly any[] 数组 2
• 返回值: boolean 数组 1 是否包含数组 2 的全部元素

检测集合的包含关系。

intersection(array1, array2)

• array1: readonly any[] 数组 1
• array2: readonly any[] 数组 2
• 返回值: any[] 两个数组的交集

求两个集合的交集。

difference(array1, array2)

• array1: readonly any[] 数组 1
• array2: readonly any[] 数组 2
• 返回值: any[] 两个数组的差集

求两个集合的差集。

union(array1, array2)

• array1: readonly any[] 数组 1
• array2: readonly any[] 数组 2
• 返回值: any[] 两个数组的并集

求两个集合的并集。

日期操作

静态属性

• Time.millisecond
• Time.second
• Time.minute
• Time.hour
• Time.day
• Time.week

Time.getDateNumber(date?)

• date: Date 日期对象，默认为 new Date()
• 返回值: number UNIX 时间开始后的天数

获取当前日期（从 UNIX 时间开始时计算）。

Time.fromDateNumber(value)

• value: number UNIX 时间开始后的天数
• 返回值: Date 日期对象

从 UNIX 时间开始后的天数计算日期对象。

Time.parseTime(source)

• source: string 要解析的字符串

将一个字符串解析成时间长度。

Time.parseDate(source)

• source: string 要解析的字符串

将一个字符串解析成 Date 对象。

Time.format(ms)

• ms: number 毫秒数

随机数操作

Random.uuid()

• 返回值: string 生成的 UUID

生成一个标准的 UUID (v5)。

Random.bool(probability)

• probability: number 概率
• 返回值: boolean 随机布尔值

生成一个随机布尔值，有 probability 的概率为 1。

Random.real(start?, end)

• start: number 下界，默认为 0
• end: number 上界
• 返回值: number 一个 [start, end) 之间的随机实数

生成一个随机实数。

Random.int(start?, end)

• start: number 下界，默认为 0
• end: number 上界
• 返回值: number 一个 [start, end) 之间的随机整数

生成一个随机实数。

Random.shuffle(array)

• array: T[] 数组
• 返回值: T[] 新的数组

随机打乱数组中的元素，返回新的数组。

Random.pick(array)

• array: readonly T[] 数组
• 返回值: T 挑出的元素

从数组中随机挑出一个元素，不改变原数组。

Random.multiPick(array, count)

• array: readonly T[] 数组
• count: number 元素个数
• 返回值: T[] 挑出的元素列表

从数组中随机挑出一些元素，不改变原数组。

Random.weightedPick(weights, value?)

• weights: Record<T, number> 权重表
• value: number 一个 0 到 1 之间的随机数，默认为 Math.random()
• 返回值: T 挑出的元素

按照权重随机挑出一个元素。

其他工具函数

noop()

• 返回值: void

不进行任何操作（no operation）。

sleep(ms?)

• ms: number 要等待的毫秒数
• 返回值: Promise<void>

等待一段时间。

isInteger(value)

• value: any 要判断的值
• 返回值: boolean 是否为整数

判断传入的值是否为整数。