@naturalcycles/js-lib 14.192.1 → 14.193.0

package/dist/number/number.util.d.ts

@@ -6,6 +6,16 @@ export declare function _randomInt(minIncl: number, maxIncl: number): number;
  * which is not reflected in the output type)
  */
 export declare function _randomArrayItem<T>(array: T[]): T;
+/**
+ * Convenience function to "throttle" some code - run it less often.
+ *
+ * @example
+ *
+ * if (_runLessOften(10)) {
+ *   // this code will run only 10% of the time
+ * }
+ */
+export declare function _runLessOften(percent: number): boolean;
 /**
  *  _inRange(-10, 1, 5) // false
  * _inRange(1, 1, 5) // true

package/dist/number/number.util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._round = exports._toPrecision = exports._toFixed = exports._sortNumbers = exports._clamp = exports._inRange = exports._randomArrayItem = exports._randomInt = void 0;
+exports._round = exports._toPrecision = exports._toFixed = exports._sortNumbers = exports._clamp = exports._inRange = exports._runLessOften = exports._randomArrayItem = exports._randomInt = void 0;
 function _randomInt(minIncl, maxIncl) {
     return Math.floor(Math.random() * (maxIncl - minIncl + 1) + minIncl);
 }
@@ -14,6 +14,19 @@ function _randomArrayItem(array) {
     return array[_randomInt(0, array.length - 1)];
 }
 exports._randomArrayItem = _randomArrayItem;
+/**
+ * Convenience function to "throttle" some code - run it less often.
+ *
+ * @example
+ *
+ * if (_runLessOften(10)) {
+ *   // this code will run only 10% of the time
+ * }
+ */
+function _runLessOften(percent) {
+    return Math.random() * 100 < percent;
+}
+exports._runLessOften = _runLessOften;
 // todo: _.random to support floats
 /**
  *  _inRange(-10, 1, 5) // false

package/dist-esm/number/number.util.js

@@ -9,6 +9,18 @@ export function _randomInt(minIncl, maxIncl) {
 export function _randomArrayItem(array) {
     return array[_randomInt(0, array.length - 1)];
 }
+/**
+ * Convenience function to "throttle" some code - run it less often.
+ *
+ * @example
+ *
+ * if (_runLessOften(10)) {
+ *   // this code will run only 10% of the time
+ * }
+ */
+export function _runLessOften(percent) {
+    return Math.random() * 100 < percent;
+}
 // todo: _.random to support floats
 /**
  *  _inRange(-10, 1, 5) // false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.192.1",
+  "version": "14.193.0",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",

package/src/number/number.util.ts

@@ -13,6 +13,19 @@ export function _randomArrayItem<T>(array: T[]): T {
   return array[_randomInt(0, array.length - 1)]!
 }
 
+/**
+ * Convenience function to "throttle" some code - run it less often.
+ *
+ * @example
+ *
+ * if (_runLessOften(10)) {
+ *   // this code will run only 10% of the time
+ * }
+ */
+export function _runLessOften(percent: number): boolean {
+  return Math.random() * 100 < percent
+}
+
 // todo: _.random to support floats
 
 /**