number

Source: index.js:6

数字处理工具函数

Static Methods

average(values: Array.<number>): number | undefined

计算有限数字数组的算术平均值。

Parameters

• values (Array.<number>) — 数字数组

Returns

• number | undefined — 平均值；空数组返回 undefined

Throws

• TypeError — 参数不是有限数字数组时抛出

clamp(value: number, lower: number, upper: number): number

将数字限制在包含边界的区间内。

Parameters

• value (number) — 要限制的数字
• lower (number) — 区间下界
• upper (number) — 区间上界

Returns

• number — 限制后的数字

Throws

• TypeError | RangeError — 参数不是有限数字或边界倒置时抛出

inRange(value: number, start: number, end?: number): boolean

判断数字是否位于指定区间，区间包含下界但不包含上界。

Parameters

• value (number) — 待判断的数字
• start (number) — 区间起点，省略 end 时作为 end 使用
• end (number, optional) — 区间终点

Returns

• boolean — 是否位于区间内

Throws

• TypeError — 参数不是有限数字时抛出

isDigit(value: *): boolean

判断值是否为只包含 ASCII 数字的非空字符串。

Parameters

• value (*) — 待判断的值

Returns

• boolean — 是否为数字字符串

isPrimes(number: number): boolean

判断整数是否为素数。

Parameters

• number (number) — 待判断的整数

Returns

• boolean — 是素数时为 true

Throws

• TypeError — 参数不是整数时抛出

randomBetween(min?: number, max?: number): number

生成指定闭区间内的随机整数。

Parameters

• min (number, optional, default: 1) — 最小整数
• max (number, optional, default: 100) — 最大整数

Returns

• number — 闭区间内的随机整数

Throws

• TypeError | RangeError — 参数不是整数或 min 大于 max 时抛出

round(value: number, precision?: number): number

将数字四舍五入到指定的小数位数。

Parameters

• value (number) — 要舍入的有限数字
• precision (number, optional, default: 0) — 小数位数，可为负数

Returns

• number — 舍入后的数字

Throws

• TypeError — 参数类型不正确时抛出

sum(values: Array.<number>): number

计算有限数字数组的总和。

Parameters

• values (Array.<number>) — 数字数组

Returns

• number — 数字总和，空数组返回 0

Throws

• TypeError — 参数不是有限数字数组时抛出