si-funciona 2.3.3 → 2.4.0

package/dist/helpers/functions/relevancyFilter.js

@@ -1,34 +1,34 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.filter.js')
-require('core-js/modules/esnext.iterator.map.js')
-require('core-js/stable')
-/**
- * Remove elements out of relevance range and update the max relevance.
- * @memberOf module:functionHelpers
- * @param {relevanceMap} map
- * @param {Object} [options={}]
- * @param {int} [options.mapLimit=1000]
- * @param {int} [options.relevancyRange=100]
- * @returns {relevanceMap}
- */
-const relevancyFilter = (map, {
-  mapLimit = 1000,
-  relevancyRange = 100
-} = {}) => {
-  if (map.length <= mapLimit) {
-    return map
-  }
-  const minRelevance = map.length - relevancyRange
-  const filtered = map.filter(reference => reference.relevance >= minRelevance)
-  return filtered.map(reference => {
-    reference.relevance = reference.relevance > filtered.length ? filtered.length : reference.relevance
-    return reference
-  })
-}
-var _default = exports.default = relevancyFilter
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.filter.js')
+require('core-js/modules/esnext.iterator.map.js')
+require('core-js/stable')
+/**
+ * Remove elements out of relevance range and update the max relevance.
+ * @memberOf module:functionHelpers
+ * @param {relevanceMap} map
+ * @param {Object} [options={}]
+ * @param {number} [options.mapLimit=1000] - Only filter once the map exceeds this many entries.
+ * @param {number} [options.relevancyRange=100] - How many of the most-recent relevance values to keep.
+ * @returns {relevanceMap}
+ */
+const relevancyFilter = (map, {
+  mapLimit = 1000,
+  relevancyRange = 100
+} = {}) => {
+  if (map.length <= mapLimit) {
+    return map
+  }
+  const minRelevance = map.length - relevancyRange
+  const filtered = map.filter(reference => reference.relevance >= minRelevance)
+  return filtered.map(reference => {
+    reference.relevance = reference.relevance > filtered.length ? filtered.length : reference.relevance
+    return reference
+  })
+}
+var _default = exports.default = relevancyFilter

package/dist/helpers/functions/trace.d.ts

@@ -1,13 +1,15 @@
-import 'core-js/stable';
-import 'regenerator-runtime/runtime';
-type outputAndReturn = (value: any) => any;
-/**
- * Output the value with label to the console and return the value to not interrupt the code.
- * @memberOf module:functionHelpers
- * @param {string} label - Pass an identifying label of the value being output.
- * @param useClone - Determines if the logged data should be a clone of the original to preserve state.
- * @returns {function(*=)}
- */
-declare const trace: (label: string, useClone?: boolean) => outputAndReturn;
-export default trace;
+import 'core-js/stable';
+import 'regenerator-runtime/runtime';
+type outputAndReturn = (value: any) => any;
+/**
+ * Output the value with label to the console and return the value to not interrupt the code - useful for
+ * inspecting a value mid-pipe/mid-chain without altering the result.
+ * @memberOf module:functionHelpers
+ * @param {string} label - Pass an identifying label of the value being output.
+ * @param {boolean} [useClone=true] - Determines if the logged data should be a clone of the original to preserve
+ * its state at the time of logging (rather than a live reference that may show later mutations).
+ * @returns {function(*=)}
+ */
+declare const trace: (label: string, useClone?: boolean) => outputAndReturn;
+export default trace;
 //# sourceMappingURL=trace.d.ts.map

package/dist/helpers/functions/trace.js

@@ -1,23 +1,25 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-require('regenerator-runtime/runtime')
-var _cloneObject = _interopRequireDefault(require('../objects/cloneObject'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Output the value with label to the console and return the value to not interrupt the code.
- * @memberOf module:functionHelpers
- * @param {string} label - Pass an identifying label of the value being output.
- * @param useClone - Determines if the logged data should be a clone of the original to preserve state.
- * @returns {function(*=)}
- */
-const trace = (label, useClone = true) => value => {
-  // noinspection JSForgottenDebugStatementInspection
-  console.info(`${label}: `, useClone ? (0, _cloneObject.default)(value) : value)
-  return value
-}
-var _default = exports.default = trace
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+require('regenerator-runtime/runtime')
+var _cloneObject = _interopRequireDefault(require('../objects/cloneObject'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Output the value with label to the console and return the value to not interrupt the code - useful for
+ * inspecting a value mid-pipe/mid-chain without altering the result.
+ * @memberOf module:functionHelpers
+ * @param {string} label - Pass an identifying label of the value being output.
+ * @param {boolean} [useClone=true] - Determines if the logged data should be a clone of the original to preserve
+ * its state at the time of logging (rather than a live reference that may show later mutations).
+ * @returns {function(*=)}
+ */
+const trace = (label, useClone = true) => value => {
+  // noinspection JSForgottenDebugStatementInspection
+  console.info(`${label}: `, useClone ? (0, _cloneObject.default)(value) : value)
+  return value
+}
+var _default = exports.default = trace

package/dist/helpers/functions.d.ts

@@ -1,30 +1,30 @@
-/**
- * Manage how functions are called with these utilities.
- * @file
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @module functionHelpers
- * @memberOf module:siFunciona
- */
-import 'core-js/stable';
-declare const _default: {
-    callWithParams: (fn: Function, params?: Array<any>, minimum?: number) => any;
-    curry: (fn: Function) => Function | any;
-    delay: (time?: number) => {
-        resolver: Promise<any>;
-        cancel: () => void;
-    };
-    makeBasicQueue: (initialQueue?: import("./arrays/BasicQueue").queuedItem[] | any) => import("./arrays/BasicQueue").IsQueue<any>;
-    onBodyLoad: (callback: Function, reset?: boolean) => Array<Function>;
-    pipe: (...fns: Function[]) => any;
-    preloadParams: (fn: Function, params?: Array<any>, unassignedParam?: number) => (missing: any) => any;
-    queueManager: (queue?: import("./arrays/BasicQueue").IsQueue<import("./arrays/BasicQueue").queuedItem>) => import("./functions/queueManager").queueManagerHandle;
-    queueTimeout: (queueManagerHandle?: import("./functions/queueManager").queueManagerHandle) => (fn: Function, time: number, ...args: any) => Promise<any>;
-    relevancyFilter: (map: import("./functions/relevancyFilter").relevanceMap, { mapLimit, relevancyRange }?: {
-        mapLimit?: number;
-        relevancyRange?: number;
-    }) => import("./functions/relevancyFilter").relevanceMap;
-    trace: (label: string, useClone?: boolean) => (value: any) => any;
-};
-export default _default;
+/**
+ * Manage how functions are called with these utilities.
+ * @file
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @module functionHelpers
+ * @memberOf module:siFunciona
+ */
+import 'core-js/stable';
+declare const _default: {
+    callWithParams: (fn: Function, params?: Array<any>, minimum?: number) => any;
+    curry: (fn: Function) => Function | any;
+    delay: (time?: number) => {
+        resolver: Promise<any>;
+        cancel: () => void;
+    };
+    makeBasicQueue: (initialQueue?: import("./arrays/BasicQueue").queuedItem[] | any) => import("./arrays/BasicQueue").IsQueue<any>;
+    onBodyLoad: (callback: Function, reset?: boolean) => Array<Function>;
+    pipe: (...fns: Function[]) => any;
+    preloadParams: (fn: Function, params?: Array<any>, unassignedParam?: number) => (missing: any) => any;
+    queueManager: (queue?: import("./arrays/BasicQueue").IsQueue<import("./arrays/BasicQueue").queuedItem>) => import("./functions/queueManager").queueManagerHandle;
+    queueTimeout: (queueManagerHandle?: import("./functions/queueManager").queueManagerHandle) => (fn: Function, time: number, ...args: any) => Promise<any>;
+    relevancyFilter: (map: import("./functions/relevancyFilter").relevanceMap, { mapLimit, relevancyRange }?: {
+        mapLimit?: number;
+        relevancyRange?: number;
+    }) => import("./functions/relevancyFilter").relevanceMap;
+    trace: (label: string, useClone?: boolean) => (value: any) => any;
+};
+export default _default;
 //# sourceMappingURL=functions.d.ts.map

package/dist/helpers/functions.js

@@ -1,40 +1,40 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-var _callWithParams = _interopRequireDefault(require('./functions/callWithParams'))
-var _curry = _interopRequireDefault(require('./functions/curry'))
-var _delay = _interopRequireDefault(require('./functions/delay'))
-var _makeBasicQueue = _interopRequireDefault(require('./functions/makeBasicQueue'))
-var _onBodyLoad = _interopRequireDefault(require('./functions/onBodyLoad'))
-var _pipe = _interopRequireDefault(require('./functions/pipe'))
-var _preloadParams = _interopRequireDefault(require('./functions/preloadParams'))
-var _queueManager = _interopRequireDefault(require('./functions/queueManager'))
-var _queueTimeout = _interopRequireDefault(require('./functions/queueTimeout'))
-var _relevancyFilter = _interopRequireDefault(require('./functions/relevancyFilter'))
-var _trace = _interopRequireDefault(require('./functions/trace'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Manage how functions are called with these utilities.
- * @file
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @module functionHelpers
- * @memberOf module:siFunciona
- */
-var _default = exports.default = {
-  callWithParams: _callWithParams.default,
-  curry: _curry.default,
-  delay: _delay.default,
-  makeBasicQueue: _makeBasicQueue.default,
-  onBodyLoad: _onBodyLoad.default,
-  pipe: _pipe.default,
-  preloadParams: _preloadParams.default,
-  queueManager: _queueManager.default,
-  queueTimeout: _queueTimeout.default,
-  relevancyFilter: _relevancyFilter.default,
-  trace: _trace.default
-}
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+var _callWithParams = _interopRequireDefault(require('./functions/callWithParams'))
+var _curry = _interopRequireDefault(require('./functions/curry'))
+var _delay = _interopRequireDefault(require('./functions/delay'))
+var _makeBasicQueue = _interopRequireDefault(require('./functions/makeBasicQueue'))
+var _onBodyLoad = _interopRequireDefault(require('./functions/onBodyLoad'))
+var _pipe = _interopRequireDefault(require('./functions/pipe'))
+var _preloadParams = _interopRequireDefault(require('./functions/preloadParams'))
+var _queueManager = _interopRequireDefault(require('./functions/queueManager'))
+var _queueTimeout = _interopRequireDefault(require('./functions/queueTimeout'))
+var _relevancyFilter = _interopRequireDefault(require('./functions/relevancyFilter'))
+var _trace = _interopRequireDefault(require('./functions/trace'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Manage how functions are called with these utilities.
+ * @file
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @module functionHelpers
+ * @memberOf module:siFunciona
+ */
+var _default = exports.default = {
+  callWithParams: _callWithParams.default,
+  curry: _curry.default,
+  delay: _delay.default,
+  makeBasicQueue: _makeBasicQueue.default,
+  onBodyLoad: _onBodyLoad.default,
+  pipe: _pipe.default,
+  preloadParams: _preloadParams.default,
+  queueManager: _queueManager.default,
+  queueTimeout: _queueTimeout.default,
+  relevancyFilter: _relevancyFilter.default,
+  trace: _trace.default
+}

package/dist/helpers/numbers/absoluteMax.d.ts

@@ -1,11 +1,11 @@
-import 'core-js/stable';
-/**
- * Helper for returning the absolute max value
- * @memberOf module:numberHelpers
- * @param {number} num1 - A number to compare
- * @param {number} num2 - Another number to be compared against
- * @returns {number}
- */
-declare const absoluteMax: (num1: number, num2: number) => number;
-export default absoluteMax;
+import 'core-js/stable';
+/**
+ * Helper for returning the absolute max value
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - A number to compare
+ * @param {number} num2 - Another number to be compared against
+ * @returns {number}
+ */
+declare const absoluteMax: (num1: number, num2: number) => number;
+export default absoluteMax;
 //# sourceMappingURL=absoluteMax.d.ts.map

package/dist/helpers/numbers/absoluteMax.js

@@ -1,16 +1,16 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-/**
- * Helper for returning the absolute max value
- * @memberOf module:numberHelpers
- * @param {number} num1 - A number to compare
- * @param {number} num2 - Another number to be compared against
- * @returns {number}
- */
-const absoluteMax = (num1, num2) => Math.abs(num1) > Math.abs(num2) ? num1 : num2
-var _default = exports.default = absoluteMax
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+/**
+ * Helper for returning the absolute max value
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - A number to compare
+ * @param {number} num2 - Another number to be compared against
+ * @returns {number}
+ */
+const absoluteMax = (num1, num2) => Math.abs(num1) > Math.abs(num2) ? num1 : num2
+var _default = exports.default = absoluteMax

package/dist/helpers/numbers/absoluteMin.d.ts

@@ -1,11 +1,11 @@
-import 'core-js/stable';
-/**
- * Helper for returning the absolute min value
- * @memberOf module:numberHelpers
- * @param {number} num1 - A number to compare
- * @param {number} num2 - Another number to be compared against
- * @returns {number}
- */
-declare const absoluteMin: (num1: number, num2: number) => number;
-export default absoluteMin;
+import 'core-js/stable';
+/**
+ * Helper for returning the absolute min value
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - A number to compare
+ * @param {number} num2 - Another number to be compared against
+ * @returns {number}
+ */
+declare const absoluteMin: (num1: number, num2: number) => number;
+export default absoluteMin;
 //# sourceMappingURL=absoluteMin.d.ts.map

package/dist/helpers/numbers/absoluteMin.js

@@ -1,16 +1,16 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-/**
- * Helper for returning the absolute min value
- * @memberOf module:numberHelpers
- * @param {number} num1 - A number to compare
- * @param {number} num2 - Another number to be compared against
- * @returns {number}
- */
-const absoluteMin = (num1, num2) => Math.abs(num1) < Math.abs(num2) ? num1 : num2
-var _default = exports.default = absoluteMin
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+/**
+ * Helper for returning the absolute min value
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - A number to compare
+ * @param {number} num2 - Another number to be compared against
+ * @returns {number}
+ */
+const absoluteMin = (num1, num2) => Math.abs(num1) < Math.abs(num2) ? num1 : num2
+var _default = exports.default = absoluteMin

package/dist/helpers/numbers/compare.d.ts

@@ -1,14 +1,14 @@
-import 'core-js/stable';
-/**
- * Compare two numbers and return:
- * -1 to indicate val1 is less than val2
- * 0 to indicate both values are the equal
- * 1 to indicate val1 is greater than val2
- * @memberOf module:numberHelpers
- * @param {number} val1 - The first number to compare
- * @param {number} val2 - The second number to compare
- * @returns {number}
- */
-declare const compare: (val1: number, val2: number) => number;
-export default compare;
+import 'core-js/stable';
+/**
+ * Compare two numbers and return:
+ * -1 to indicate val1 is less than val2
+ * 0 to indicate both values are the equal
+ * 1 to indicate val1 is greater than val2
+ * @memberOf module:numberHelpers
+ * @param {number} val1 - The first number to compare
+ * @param {number} val2 - The second number to compare
+ * @returns {number}
+ */
+declare const compare: (val1: number, val2: number) => number;
+export default compare;
 //# sourceMappingURL=compare.d.ts.map

package/dist/helpers/numbers/compare.js

@@ -1,19 +1,19 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-/**
- * Compare two numbers and return:
- * -1 to indicate val1 is less than val2
- * 0 to indicate both values are the equal
- * 1 to indicate val1 is greater than val2
- * @memberOf module:numberHelpers
- * @param {number} val1 - The first number to compare
- * @param {number} val2 - The second number to compare
- * @returns {number}
- */
-const compare = (val1, val2) => val1 === val2 ? 0 : val1 > val2 ? 1 : -1
-var _default = exports.default = compare
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+/**
+ * Compare two numbers and return:
+ * -1 to indicate val1 is less than val2
+ * 0 to indicate both values are the equal
+ * 1 to indicate val1 is greater than val2
+ * @memberOf module:numberHelpers
+ * @param {number} val1 - The first number to compare
+ * @param {number} val2 - The second number to compare
+ * @returns {number}
+ */
+const compare = (val1, val2) => val1 === val2 ? 0 : val1 > val2 ? 1 : -1
+var _default = exports.default = compare

package/dist/helpers/numbers/greatestCommonDivisor.d.ts

@@ -1,11 +1,11 @@
-import 'core-js/stable';
-/**
- * Return the highest number that can be divided into both numbers.
- * @memberOf module:numberHelpers
- * @param {number} num1 - First number to assess
- * @param {number} num2 - Second number to compare for common divisor
- * @returns {number}
- */
-declare const greatestCommonDivisor: (num1: number, num2: number) => number;
-export default greatestCommonDivisor;
+import 'core-js/stable';
+/**
+ * Return the highest number that can be divided into both numbers.
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - First number to assess
+ * @param {number} num2 - Second number to compare for common divisor
+ * @returns {number}
+ */
+declare const greatestCommonDivisor: (num1: number, num2: number) => number;
+export default greatestCommonDivisor;
 //# sourceMappingURL=greatestCommonDivisor.d.ts.map

package/dist/helpers/numbers/greatestCommonDivisor.js

@@ -1,16 +1,16 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-/**
- * Return the highest number that can be divided into both numbers.
- * @memberOf module:numberHelpers
- * @param {number} num1 - First number to assess
- * @param {number} num2 - Second number to compare for common divisor
- * @returns {number}
- */
-const greatestCommonDivisor = (num1, num2) => num2 === 0 ? num1 : greatestCommonDivisor(num2, num1 % num2)
-var _default = exports.default = greatestCommonDivisor
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+/**
+ * Return the highest number that can be divided into both numbers.
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - First number to assess
+ * @param {number} num2 - Second number to compare for common divisor
+ * @returns {number}
+ */
+const greatestCommonDivisor = (num1, num2) => num2 === 0 ? num1 : greatestCommonDivisor(num2, num1 % num2)
+var _default = exports.default = greatestCommonDivisor

package/dist/helpers/numbers/leastCommonMultiple.d.ts

@@ -1,11 +1,11 @@
-import 'core-js/stable';
-/**
- * Helper for calculating the multiplier that would make each number relative to each other.
- * @memberOf module:numberHelpers
- * @param {number} num1 - A number to compare
- * @param {number} num2 - Another number to be compared against
- * @returns {number}
- */
-declare const leastCommonMultiple: (num1: number, num2: number) => number;
-export default leastCommonMultiple;
+import 'core-js/stable';
+/**
+ * Helper for calculating the multiplier that would make each number relative to each other.
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - A number to compare
+ * @param {number} num2 - Another number to be compared against
+ * @returns {number}
+ */
+declare const leastCommonMultiple: (num1: number, num2: number) => number;
+export default leastCommonMultiple;
 //# sourceMappingURL=leastCommonMultiple.d.ts.map

package/dist/helpers/numbers/leastCommonMultiple.js

@@ -1,18 +1,18 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-var _greatestCommonDivisor = _interopRequireDefault(require('./greatestCommonDivisor'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Helper for calculating the multiplier that would make each number relative to each other.
- * @memberOf module:numberHelpers
- * @param {number} num1 - A number to compare
- * @param {number} num2 - Another number to be compared against
- * @returns {number}
- */
-const leastCommonMultiple = (num1, num2) => num1 === 0 || num2 === 0 ? 0 : num1 * num2 / (0, _greatestCommonDivisor.default)(num1, num2)
-var _default = exports.default = leastCommonMultiple
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+var _greatestCommonDivisor = _interopRequireDefault(require('./greatestCommonDivisor'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Helper for calculating the multiplier that would make each number relative to each other.
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - A number to compare
+ * @param {number} num2 - Another number to be compared against
+ * @returns {number}
+ */
+const leastCommonMultiple = (num1, num2) => num1 === 0 || num2 === 0 ? 0 : num1 * num2 / (0, _greatestCommonDivisor.default)(num1, num2)
+var _default = exports.default = leastCommonMultiple

package/dist/helpers/numbers/lowestCommonDenominator.d.ts

@@ -1,11 +1,11 @@
-import 'core-js/stable';
-/**
- * Helper for calculating the multiplier that would make each number relative to each other.
- * @memberOf module:numberHelpers
- * @param {number} num1 - A number to compare
- * @param {number} num2 - Another number to be compared against
- * @returns {number}
- */
-declare const lowestCommonDenominator: (...numbers: number[]) => number;
-export default lowestCommonDenominator;
+import 'core-js/stable';
+/**
+ * Find the smallest number that all the given numbers divide into evenly, by reducing them pairwise with
+ * leastCommonMultiple.
+ * @memberOf module:numberHelpers
+ * @param {...number} numbers - Two or more numbers to find the lowest common denominator of.
+ * @returns {number}
+ */
+declare const lowestCommonDenominator: (...numbers: number[]) => number;
+export default lowestCommonDenominator;
 //# sourceMappingURL=lowestCommonDenominator.d.ts.map