@lijuhong1981/jsmath 1.0.15 → 1.0.17

package/index.js

@@ -44,6 +44,7 @@ import convertToRadiansCircular from "./src/convertToRadiansCircular.js";
 import convertToLatitudeRange from "./src/convertToLatitudeRange.js";
 import convertToLongitudeRange from "./src/convertToLongitudeRange.js";
 import equalsEpsilon from "./src/equalsEpsilon.js";
+import extractFraction from "./src/extractFraction.js";
 import isBetween from "./src/isBetween.js";
 import lerp from "./src/lerp.js";
 import scalarInRange from "./src/scalarInRange.js";
@@ -99,6 +100,7 @@ export {
     convertToLatitudeRange,
     convertToLongitudeRange,
     equalsEpsilon,
+    extractFraction,
     isBetween,
     lerp,
     scalarInRange,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lijuhong1981/jsmath",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "description": "",
   "main": "index.js",
   "module": "index.js",

package/src/Range.js

@@ -101,6 +101,15 @@ class Range {
         return isBetween(value, this.minimum, this.maximum, this.containsMinimum, this.containsMaximum);
     }
 
+    /**
+     * 判断一个数值是否处于该区间内
+     * @param {Number} 需要判断的数值
+     * @returns {Boolean}
+     */
+    between(value) {
+        return this.isBetween(value);
+    }
+
     /**
      * 在该区间内线性插值
      * @param {Number} percent 插值百分比，needClamp为true时约束在[0,1]区间内，为false时可超出[0,1]区间

package/src/degToRad.js

@@ -8,6 +8,7 @@ import { RADIANS_PER_DEGREE } from "./Constant.js";
  */
 function degToRad(degrees) {
     Check.typeOf.number('degrees', degrees);
+
     return degrees * RADIANS_PER_DEGREE;
 };
 

package/src/equalsEpsilon.js

@@ -1,5 +1,12 @@
 import Check from "@lijuhong1981/jscheck";
 
+/**
+ * 比较两个数值是否近似相等
+ * @param {Number} left 
+ * @param {Number} right
+ * @param {Number} epsilon=0 近似精度，Math.abs(left - right)小于或等于该值时返回true
+ * @returns {Boolean}
+ */
 function equalsEpsilon(left, right, epsilon = 0) {
     Check.typeOf.number('left', left);
     Check.typeOf.number('right', right)

package/src/extractFraction.js

@@ -0,0 +1,19 @@
+import Check from "@lijuhong1981/jscheck";
+
+/**
+ * 从一个数值中提取小数部分
+ * @param {Number} value 传入的数值
+ * @returns {Number} 提取的小数
+ */
+function extractFraction(value) {
+    Check.typeOf.number('value', value);
+
+    value = value.toString();
+    const arr = value.split('.');
+    if (arr.length === 2)
+        return parseFloat('0.' + arr[1]);
+    else
+        return 0.0;
+};
+
+export default extractFraction;

package/src/isBetween.js

@@ -13,6 +13,7 @@ function isBetween(value, rangeMinimum, rangeMaximum, equalsMinimum = true, equa
     Check.typeOf.number('value', value);
     Check.typeOf.number('rangeMinimum', rangeMinimum);
     Check.typeOf.number('rangeMaximum', rangeMaximum);
+
     if (equalsMinimum ? value < rangeMinimum : value <= rangeMinimum)
         return false;
     if (equalsMaximum ? value > rangeMaximum : value >= rangeMaximum)

package/src/parseNumber.js

@@ -1,3 +1,8 @@
+/**
+ * 自动判断传入的数值类型并转换为数字
+ * @param {Number|String} value
+ * @returns {Number}
+ */
 function parseNumber(value) {
     if (typeof value === 'string') {
         return parseFloat(value);

package/src/radToDeg.js

@@ -8,6 +8,7 @@ import { DEGREES_PER_RADIAN } from "./Constant";
  */
 function radToDeg(radians) {
     Check.typeOf.number('radians', radians);
+
     return radians * DEGREES_PER_RADIAN;
 }
 

package/src/toFixed.js

@@ -1,7 +1,14 @@
-import parseNumber from "./parseNumber.js";
+import Check from "@lijuhong1981/jscheck";
 
+/**
+ * 四舍五入一个数值至指定的小数位数
+ * @param {Number} value 传入的数值 
+ * @param {Number} decimalNumber=2 小数位数
+ * @returns {Number}
+ */
 function toFixed(value, decimalNumber = 2) {
-    value = parseNumber(value);
+    Check.typeOf.number('value', value);
+
     return parseFloat(value.toFixed(decimalNumber));
 }