Number

数字

Description:
  • 数字

Source:
Since:
  • 1.0.0

Methods

(static) clamp(number, loweropt, upper) → {number}

Description:
  • 数字限制在 lowerupper 之间的值。

Source:
Since:
  • 1.0.0
Example
clamp(-10, -5, 5); // -5

clamp(-10, 0, 5); // 0

clamp(10, -5, 5); // 5

// 仅限制上限
clamp(10, 5); // 5

clamp(-10, 5); // -10
Parameters:
Name Type Attributes Description
number number

被限制的值。

lower number <optional>

下限。默认 0

upper number

上限。默认 0

Returns:

限制后的值。

Type
number

(static) inRange(number, start, endopt) → {number}

Description:
  • 检查数字是否在 startend 之间,但不包括 end

    如果 start 大于 end 会自动交换范围参数。

Source:
Since:
  • 1.0.0
Example
inRange(3, 2, 4); // true

inRange(1, 0, 2); // true

inRange(1.2, 0.5, 1.5); // true

inRange(2.2, 0.5, 1.5); // false

inRange(-2, -2, 4); // true

inRange(4, -2, 4); // false

// 某个范围为 0 可省略最后一个参数
inRange(1, 2); // true

inRange(1, -2); // false
Parameters:
Name Type Attributes Default Description
number number

要检查的值。

start number

开始范围。

end number <optional>
0

结束范围。默认 0

Returns:

如果数字在范围内,返回 true,否则返回 false

Type
number

(static) random(loweropt, upperopt) → {number}

Description:
  • 产生一个包含 lowerupper 之间的随机浮点数。

    如果 lower 大于 upper 会自动交换参数。

Source:
Since:
  • 1.0.0
Example
// 0 到 1 之间的浮点数
random(); // 0.40340470210512236

// 2 到 4 之间的浮点数
random(2, 4); // 3.0039717466399787

// 2 到 4 之间的浮点数
random(4, 2); // 2.388398370184757

// 1.2 到 2.4 之间的浮点数
random(1.2, 2.4); // 1.6319041677720918
Parameters:
Name Type Attributes Default Description
lower number <optional>
0

下限。默认 0

upper number <optional>
1

上限。默认 1

Returns:

随机浮点数。

Type
number

(static) randomInt(loweropt, upperopt) → {number}

Description:
  • 产生一个包含 lowerupper 之间的随机整数。

    如果参数非整数 lower=Math.ceil(lower) upper=Math.floor(upper)。如果 lower 大于 upper 会自动交换参数。

Source:
Since:
  • 1.0.0
Example
// 0 到 1 之间的整数
randomInt(); // 1

// 2 到 4 之间的整数
randomInt(2, 4); // 4

// 2 到 4 之间的整数
randomInt(4, 2); // 3

// 区间只有一个整数
randomInt(1.2, 2.4); // 2
Parameters:
Name Type Attributes Default Description
lower number <optional>
0

下限。默认 0

upper number <optional>
1

上限。默认 1

Returns:

随机整数。

Type
number