pubo-utils 1.0.95 → 1.0.98

package/es/factory/index.d.ts

@@ -7,5 +7,11 @@ type ProductsObject<T, F> = {
 type Factory<C> = (config: C, key: string) => any;
 export type CreateFactory<C, F> = <T>(apis: OptionsObject<T, C>) => ProductsObject<T, F>;
 export type SuperFactory = <C, F>(factory: Factory<C>) => CreateFactory<C, F>;
+/**
+ * Creates a factory function that takes another factory function and returns a new function that creates a product object based on the options passed in.
+ *
+ * @param {SuperFactory} factory - the factory function to be used in creating the product object
+ * @return {(options: any) => any} the new factory function that creates the product object
+ */
 export declare const superFactory: SuperFactory;
 export {};

package/es/factory/index.js

@@ -14,6 +14,12 @@ var __values = this && this.__values || function (o) {
   };
   throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
 };
+/**
+ * Creates a factory function that takes another factory function and returns a new function that creates a product object based on the options passed in.
+ *
+ * @param {SuperFactory} factory - the factory function to be used in creating the product object
+ * @return {(options: any) => any} the new factory function that creates the product object
+ */
 export var superFactory = function superFactory(factory) {
   return function (options) {
     var e_1, _a;

package/es/filter/sensor.d.ts

@@ -15,8 +15,19 @@ export declare class SensorDataFilter {
     });
     filter(n: number): number;
     private calc;
+    /**
+     * A function to calculate the most frequent element in the 'tmp' array and its frequency.
+     *
+     * @return {object} An object containing the most frequent element and its frequency.
+     */
     private getMostNumberOfTmp;
 }
+/**
+ * Splits the input string using the specified split symbol and returns an array of substrings.
+ *
+ * @param {string} str - the input string to be split
+ * @return {string[]} an array of substrings
+ */
 export declare class StringSplit {
     private readonly _splitSymbol;
     private _cache;

package/es/filter/sensor.js

@@ -80,6 +80,11 @@ var SensorDataFilter = /** @class */function () {
     }
     return res;
   };
+  /**
+   * A function to calculate the most frequent element in the 'tmp' array and its frequency.
+   *
+   * @return {object} An object containing the most frequent element and its frequency.
+   */
   SensorDataFilter.prototype.getMostNumberOfTmp = function () {
     var e_1, _a;
     var a = {};
@@ -117,6 +122,12 @@ var SensorDataFilter = /** @class */function () {
   return SensorDataFilter;
 }();
 export { SensorDataFilter };
+/**
+ * Splits the input string using the specified split symbol and returns an array of substrings.
+ *
+ * @param {string} str - the input string to be split
+ * @return {string[]} an array of substrings
+ */
 var StringSplit = /** @class */function () {
   function StringSplit(splitSymbol) {
     this._cache = '';

package/es/loop/index.d.ts

@@ -1,5 +1,21 @@
+/**
+ * Executes the given callback function in a loop with the specified time interval.
+ *
+ * @param {Function} cb - The callback function to be executed in the loop. It takes a stop function as a parameter.
+ * @param {number} time - The time interval in milliseconds for the loop.
+ * @return {Function} The stop function that can be used to stop the loop.
+ */
 export declare const loop: (cb: (stop: () => void) => Promise<void>, time: number) => () => void;
 type WaitForBool = () => boolean | Promise<boolean>;
+/**
+ * Waits for a boolean condition to be true, with optional timeouts for the check and the overall wait.
+ *
+ * @param {WaitForBool} bool - the boolean condition to wait for
+ * @param {Object} options - optional parameters for checkTime and timeout
+ * @param {number} options.checkTime - the time interval for checking the boolean condition (default is 100)
+ * @param {number} options.timeout - the maximum time to wait for the boolean condition to be true
+ * @return {Promise<any>} a promise that resolves when the boolean condition is true or rejects with 'timeout' if the timeout is reached
+ */
 export declare const waitFor: (bool: WaitForBool, { checkTime, timeout }?: {
     checkTime?: number | undefined;
     timeout?: number | undefined;

package/es/loop/index.js

@@ -114,6 +114,13 @@ var __generator = this && this.__generator || function (thisArg, body) {
   }
 };
 import { sleep } from '../sleep';
+/**
+ * Executes the given callback function in a loop with the specified time interval.
+ *
+ * @param {Function} cb - The callback function to be executed in the loop. It takes a stop function as a parameter.
+ * @param {number} time - The time interval in milliseconds for the loop.
+ * @return {Function} The stop function that can be used to stop the loop.
+ */
 export var loop = function loop(cb, time) {
   var onOff = true;
   var stop = function stop() {
@@ -144,6 +151,15 @@ export var loop = function loop(cb, time) {
   _fn();
   return stop;
 };
+/**
+ * Waits for a boolean condition to be true, with optional timeouts for the check and the overall wait.
+ *
+ * @param {WaitForBool} bool - the boolean condition to wait for
+ * @param {Object} options - optional parameters for checkTime and timeout
+ * @param {number} options.checkTime - the time interval for checking the boolean condition (default is 100)
+ * @param {number} options.timeout - the maximum time to wait for the boolean condition to be true
+ * @return {Promise<any>} a promise that resolves when the boolean condition is true or rejects with 'timeout' if the timeout is reached
+ */
 export var waitFor = function waitFor(bool, _a) {
   var _b = _a === void 0 ? {} : _a,
     checkTime = _b.checkTime,

package/es/random/index.d.ts

@@ -1,2 +1,14 @@
+/**
+ * Generates a random string of specified length.
+ *
+ * @param {number} n - The length of the random string to generate
+ * @return {string} The randomly generated string
+ */
 export declare const random: (n?: number) => string;
+/**
+ * Generates a random number within the specified range.
+ *
+ * @param {number[]} range - The range within which to generate the random number.
+ * @return {number} The randomly generated number within the specified range.
+ */
 export declare const randomRangeNum: (range: any) => number;

package/es/random/index.js

@@ -1,3 +1,9 @@
+/**
+ * Generates a random string of specified length.
+ *
+ * @param {number} n - The length of the random string to generate
+ * @return {string} The randomly generated string
+ */
 var __read = this && this.__read || function (o, n) {
   var m = typeof Symbol === "function" && o[Symbol.iterator];
   if (!m) return o;
@@ -49,6 +55,12 @@ export var random = function random(n) {
   }
   return res;
 };
+/**
+ * Generates a random number within the specified range.
+ *
+ * @param {number[]} range - The range within which to generate the random number.
+ * @return {number} The randomly generated number within the specified range.
+ */
 export var randomRangeNum = function randomRangeNum(range) {
   var size = Math.abs(range[1] - range[0]);
   return Math.random() * size + Math.min.apply(Math, __spreadArray([], __read(range), false));

package/es/sleep/index.d.ts

@@ -1 +1,7 @@
+/**
+ * Asynchronous function to sleep for a specified amount of time.
+ *
+ * @param {number} time - The duration in milliseconds to sleep
+ * @return {Promise<void>} A promise that resolves after the specified time
+ */
 export declare const sleep: (time: number) => Promise<void>;

package/es/sleep/index.js

@@ -1,3 +1,9 @@
+/**
+ * Asynchronous function to sleep for a specified amount of time.
+ *
+ * @param {number} time - The duration in milliseconds to sleep
+ * @return {Promise<void>} A promise that resolves after the specified time
+ */
 var __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
   function adopt(value) {
     return value instanceof P ? value : new P(function (resolve) {

package/lib/factory/index.d.ts

@@ -7,5 +7,11 @@ type ProductsObject<T, F> = {
 type Factory<C> = (config: C, key: string) => any;
 export type CreateFactory<C, F> = <T>(apis: OptionsObject<T, C>) => ProductsObject<T, F>;
 export type SuperFactory = <C, F>(factory: Factory<C>) => CreateFactory<C, F>;
+/**
+ * Creates a factory function that takes another factory function and returns a new function that creates a product object based on the options passed in.
+ *
+ * @param {SuperFactory} factory - the factory function to be used in creating the product object
+ * @return {(options: any) => any} the new factory function that creates the product object
+ */
 export declare const superFactory: SuperFactory;
 export {};

package/lib/factory/index.js

@@ -20,6 +20,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.superFactory = void 0;
+/**
+ * Creates a factory function that takes another factory function and returns a new function that creates a product object based on the options passed in.
+ *
+ * @param {SuperFactory} factory - the factory function to be used in creating the product object
+ * @return {(options: any) => any} the new factory function that creates the product object
+ */
 var superFactory = function superFactory(factory) {
   return function (options) {
     var e_1, _a;

package/lib/filter/sensor.d.ts

@@ -15,8 +15,19 @@ export declare class SensorDataFilter {
     });
     filter(n: number): number;
     private calc;
+    /**
+     * A function to calculate the most frequent element in the 'tmp' array and its frequency.
+     *
+     * @return {object} An object containing the most frequent element and its frequency.
+     */
     private getMostNumberOfTmp;
 }
+/**
+ * Splits the input string using the specified split symbol and returns an array of substrings.
+ *
+ * @param {string} str - the input string to be split
+ * @return {string[]} an array of substrings
+ */
 export declare class StringSplit {
     private readonly _splitSymbol;
     private _cache;

package/lib/filter/sensor.js

@@ -86,6 +86,11 @@ var SensorDataFilter = /** @class */function () {
     }
     return res;
   };
+  /**
+   * A function to calculate the most frequent element in the 'tmp' array and its frequency.
+   *
+   * @return {object} An object containing the most frequent element and its frequency.
+   */
   SensorDataFilter.prototype.getMostNumberOfTmp = function () {
     var e_1, _a;
     var a = {};
@@ -123,6 +128,12 @@ var SensorDataFilter = /** @class */function () {
   return SensorDataFilter;
 }();
 exports.SensorDataFilter = SensorDataFilter;
+/**
+ * Splits the input string using the specified split symbol and returns an array of substrings.
+ *
+ * @param {string} str - the input string to be split
+ * @return {string[]} an array of substrings
+ */
 var StringSplit = /** @class */function () {
   function StringSplit(splitSymbol) {
     this._cache = '';

package/lib/loop/index.d.ts

@@ -1,5 +1,21 @@
+/**
+ * Executes the given callback function in a loop with the specified time interval.
+ *
+ * @param {Function} cb - The callback function to be executed in the loop. It takes a stop function as a parameter.
+ * @param {number} time - The time interval in milliseconds for the loop.
+ * @return {Function} The stop function that can be used to stop the loop.
+ */
 export declare const loop: (cb: (stop: () => void) => Promise<void>, time: number) => () => void;
 type WaitForBool = () => boolean | Promise<boolean>;
+/**
+ * Waits for a boolean condition to be true, with optional timeouts for the check and the overall wait.
+ *
+ * @param {WaitForBool} bool - the boolean condition to wait for
+ * @param {Object} options - optional parameters for checkTime and timeout
+ * @param {number} options.checkTime - the time interval for checking the boolean condition (default is 100)
+ * @param {number} options.timeout - the maximum time to wait for the boolean condition to be true
+ * @return {Promise<any>} a promise that resolves when the boolean condition is true or rejects with 'timeout' if the timeout is reached
+ */
 export declare const waitFor: (bool: WaitForBool, { checkTime, timeout }?: {
     checkTime?: number | undefined;
     timeout?: number | undefined;

package/lib/loop/index.js

@@ -120,6 +120,13 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.waitFor = exports.loop = void 0;
 var sleep_1 = require("../sleep");
+/**
+ * Executes the given callback function in a loop with the specified time interval.
+ *
+ * @param {Function} cb - The callback function to be executed in the loop. It takes a stop function as a parameter.
+ * @param {number} time - The time interval in milliseconds for the loop.
+ * @return {Function} The stop function that can be used to stop the loop.
+ */
 var loop = function loop(cb, time) {
   var onOff = true;
   var stop = function stop() {
@@ -151,6 +158,15 @@ var loop = function loop(cb, time) {
   return stop;
 };
 exports.loop = loop;
+/**
+ * Waits for a boolean condition to be true, with optional timeouts for the check and the overall wait.
+ *
+ * @param {WaitForBool} bool - the boolean condition to wait for
+ * @param {Object} options - optional parameters for checkTime and timeout
+ * @param {number} options.checkTime - the time interval for checking the boolean condition (default is 100)
+ * @param {number} options.timeout - the maximum time to wait for the boolean condition to be true
+ * @return {Promise<any>} a promise that resolves when the boolean condition is true or rejects with 'timeout' if the timeout is reached
+ */
 var waitFor = function waitFor(bool, _a) {
   var _b = _a === void 0 ? {} : _a,
     checkTime = _b.checkTime,

package/lib/random/index.d.ts

@@ -1,2 +1,14 @@
+/**
+ * Generates a random string of specified length.
+ *
+ * @param {number} n - The length of the random string to generate
+ * @return {string} The randomly generated string
+ */
 export declare const random: (n?: number) => string;
+/**
+ * Generates a random number within the specified range.
+ *
+ * @param {number[]} range - The range within which to generate the random number.
+ * @return {number} The randomly generated number within the specified range.
+ */
 export declare const randomRangeNum: (range: any) => number;

package/lib/random/index.js

@@ -1,5 +1,11 @@
 "use strict";
 
+/**
+ * Generates a random string of specified length.
+ *
+ * @param {number} n - The length of the random string to generate
+ * @return {string} The randomly generated string
+ */
 var __read = this && this.__read || function (o, n) {
   var m = typeof Symbol === "function" && o[Symbol.iterator];
   if (!m) return o;
@@ -56,6 +62,12 @@ var random = function random(n) {
   return res;
 };
 exports.random = random;
+/**
+ * Generates a random number within the specified range.
+ *
+ * @param {number[]} range - The range within which to generate the random number.
+ * @return {number} The randomly generated number within the specified range.
+ */
 var randomRangeNum = function randomRangeNum(range) {
   var size = Math.abs(range[1] - range[0]);
   return Math.random() * size + Math.min.apply(Math, __spreadArray([], __read(range), false));

package/lib/sleep/index.d.ts

@@ -1 +1,7 @@
+/**
+ * Asynchronous function to sleep for a specified amount of time.
+ *
+ * @param {number} time - The duration in milliseconds to sleep
+ * @return {Promise<void>} A promise that resolves after the specified time
+ */
 export declare const sleep: (time: number) => Promise<void>;

package/lib/sleep/index.js

@@ -1,5 +1,11 @@
 "use strict";
 
+/**
+ * Asynchronous function to sleep for a specified amount of time.
+ *
+ * @param {number} time - The duration in milliseconds to sleep
+ * @return {Promise<void>} A promise that resolves after the specified time
+ */
 var __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
   function adopt(value) {
     return value instanceof P ? value : new P(function (resolve) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pubo-utils",
-  "version": "1.0.95",
+  "version": "1.0.98",
   "main": "./lib/index.js",
   "module": "./es/index.js",
   "types": "./lib/index.d.ts",
@@ -18,5 +18,5 @@
   "engines": {
     "node": ">=8.0.0"
   },
-  "gitHead": "d626fb18ee0b20c0377396a0f2c3aa983ebb3e59"
+  "gitHead": "4f1b1c6ff194adccef99ba0cead655b0ce82a406"
 }