si-funciona 2.3.3 → 2.3.4

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/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

package/dist/helpers/numbers/lowestCommonDenominator.js

@@ -1,20 +1,20 @@
-'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.reduce.js')
-require('core-js/stable')
-var _leastCommonMultiple = _interopRequireDefault(require('./leastCommonMultiple'))
-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 lowestCommonDenominator = (...numbers) => numbers.reduce((num1, num2) => (0, _leastCommonMultiple.default)(num1, num2), 1)
-var _default = exports.default = lowestCommonDenominator
+'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.reduce.js')
+require('core-js/stable')
+var _leastCommonMultiple = _interopRequireDefault(require('./leastCommonMultiple'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * 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}
+ */
+const lowestCommonDenominator = (...numbers) => numbers.reduce((num1, num2) => (0, _leastCommonMultiple.default)(num1, num2), 1)
+var _default = exports.default = lowestCommonDenominator

package/dist/helpers/strings/camelCase.d.ts

@@ -1,10 +1,10 @@
-import 'core-js/stable';
-/**
- * Given a string in kebab-case, snake_case or 'Sentence case', convert to camelCase.
- * @memberOf module:stringHelpers
- * @param {string} str
- * @returns {string}
- */
-declare const camelCase: (str: string) => string;
-export default camelCase;
+import 'core-js/stable';
+/**
+ * Given a string in kebab-case, snake_case or 'Sentence case', convert to camelCase.
+ * @memberOf module:stringHelpers
+ * @param {string} str - The string to convert.
+ * @returns {string}
+ */
+declare const camelCase: (str: string) => string;
+export default camelCase;
 //# sourceMappingURL=camelCase.d.ts.map

package/dist/helpers/strings/camelCase.js

@@ -1,20 +1,20 @@
-'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.reduce.js')
-require('core-js/stable')
-var _ucFirst = _interopRequireDefault(require('./ucFirst'))
-var _words = _interopRequireDefault(require('./words'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Given a string in kebab-case, snake_case or 'Sentence case', convert to camelCase.
- * @memberOf module:stringHelpers
- * @param {string} str
- * @returns {string}
- */
-const camelCase = str => (0, _words.default)(str).reduce((camel, part) => camel ? camel.concat((0, _ucFirst.default)(part)) : part.toLowerCase(), '')
-var _default = exports.default = camelCase
+'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.reduce.js')
+require('core-js/stable')
+var _ucFirst = _interopRequireDefault(require('./ucFirst'))
+var _words = _interopRequireDefault(require('./words'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Given a string in kebab-case, snake_case or 'Sentence case', convert to camelCase.
+ * @memberOf module:stringHelpers
+ * @param {string} str - The string to convert.
+ * @returns {string}
+ */
+const camelCase = str => (0, _words.default)(str).reduce((camel, part) => camel ? camel.concat((0, _ucFirst.default)(part)) : part.toLowerCase(), '')
+var _default = exports.default = camelCase

package/dist/helpers/strings/kabobCase.d.ts

@@ -1,10 +1,10 @@
-import 'core-js/stable';
-/**
- * Given a string in snake_case, camelCase or 'Sentence case', convert to kabob-case.
- * @memberOf module:stringHelpers
- * @param {string} str
- * @returns {string}
- */
-declare const kabobCase: (str: string) => string;
-export default kabobCase;
+import 'core-js/stable';
+/**
+ * Given a string in snake_case, camelCase or 'Sentence case', convert to kabob-case.
+ * @memberOf module:stringHelpers
+ * @param {string} str - The string to convert.
+ * @returns {string}
+ */
+declare const kabobCase: (str: string) => string;
+export default kabobCase;
 //# sourceMappingURL=kabobCase.d.ts.map

package/dist/helpers/strings/kabobCase.js

@@ -1,19 +1,19 @@
-'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.reduce.js')
-require('core-js/stable')
-var _words = _interopRequireDefault(require('./words'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Given a string in snake_case, camelCase or 'Sentence case', convert to kabob-case.
- * @memberOf module:stringHelpers
- * @param {string} str
- * @returns {string}
- */
-const kabobCase = str => (0, _words.default)(str).reduce((kabob, part) => kabob ? kabob.concat('-' + part.toLowerCase()) : part.toLowerCase(), '')
-var _default = exports.default = kabobCase
+'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.reduce.js')
+require('core-js/stable')
+var _words = _interopRequireDefault(require('./words'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Given a string in snake_case, camelCase or 'Sentence case', convert to kabob-case.
+ * @memberOf module:stringHelpers
+ * @param {string} str - The string to convert.
+ * @returns {string}
+ */
+const kabobCase = str => (0, _words.default)(str).reduce((kabob, part) => kabob ? kabob.concat('-' + part.toLowerCase()) : part.toLowerCase(), '')
+var _default = exports.default = kabobCase

package/dist/helpers/strings/makeFilepath.d.ts

@@ -1,10 +1,10 @@
-/**
- * Format the given path so that it does not have trailing slashes and also correctly appends a path.
- * @memberOf module:stringHelpers
- * @param {string} root
- * @param {string} [append='']
- * @returns {string}
- */
-export declare const makeFilepath: (root: string, append?: string) => string;
-export default makeFilepath;
+/**
+ * Format the given path so that it does not have trailing slashes and also correctly appends a path.
+ * @memberOf module:stringHelpers
+ * @param {string} root - The base path to start from.
+ * @param {string} [append=''] - A path to append to `root` - may itself use `./` or `../` segments.
+ * @returns {string}
+ */
+export declare const makeFilepath: (root: string, append?: string) => string;
+export default makeFilepath;
 //# sourceMappingURL=makeFilepath.d.ts.map

package/dist/helpers/strings/makeFilepath.js

@@ -1,49 +1,49 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.makeFilepath = exports.default = void 0
-var _strBeforeLast = _interopRequireDefault(require('./strBeforeLast'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Format the given path so that it does not have trailing slashes and also correctly appends a path.
- * @memberOf module:stringHelpers
- * @param {string} root
- * @param {string} [append='']
- * @returns {string}
- */
-const makeFilepath = (root, append = '') => {
-  if (root.startsWith('./')) {
-    root = root.slice(2)
-  }
-  if (root.startsWith('/')) {
-    root = root.slice(1)
-  }
-  if (root.endsWith('/')) {
-    root = root.slice(0, -1)
-  }
-  if (append.startsWith('/')) {
-    append = append.slice(1)
-  }
-  if (append.startsWith('./')) {
-    append = append.slice(2)
-  }
-  if (append.startsWith('../')) {
-    if (!root) {
-      return append.endsWith('/') ? append.slice(0, -1) : append
-    }
-    append = append.slice(3)
-    root = (0, _strBeforeLast.default)(root, '/')
-    return makeFilepath(root, append)
-  }
-  if (append.endsWith('/')) {
-    append = append.slice(0, -1)
-  }
-  if (!root) {
-    return append
-  }
-  return append ? `${root}/${append}` : root
-}
-exports.makeFilepath = makeFilepath
-var _default = exports.default = makeFilepath
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.makeFilepath = exports.default = void 0
+var _strBeforeLast = _interopRequireDefault(require('./strBeforeLast'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Format the given path so that it does not have trailing slashes and also correctly appends a path.
+ * @memberOf module:stringHelpers
+ * @param {string} root - The base path to start from.
+ * @param {string} [append=''] - A path to append to `root` - may itself use `./` or `../` segments.
+ * @returns {string}
+ */
+const makeFilepath = (root, append = '') => {
+  if (root.startsWith('./')) {
+    root = root.slice(2)
+  }
+  if (root.startsWith('/')) {
+    root = root.slice(1)
+  }
+  if (root.endsWith('/')) {
+    root = root.slice(0, -1)
+  }
+  if (append.startsWith('/')) {
+    append = append.slice(1)
+  }
+  if (append.startsWith('./')) {
+    append = append.slice(2)
+  }
+  if (append.startsWith('../')) {
+    if (!root) {
+      return append.endsWith('/') ? append.slice(0, -1) : append
+    }
+    append = append.slice(3)
+    root = (0, _strBeforeLast.default)(root, '/')
+    return makeFilepath(root, append)
+  }
+  if (append.endsWith('/')) {
+    append = append.slice(0, -1)
+  }
+  if (!root) {
+    return append
+  }
+  return append ? `${root}/${append}` : root
+}
+exports.makeFilepath = makeFilepath
+var _default = exports.default = makeFilepath

package/dist/helpers/strings/makeRelativePath.d.ts

@@ -1,10 +1,10 @@
-/**
- * Compare two file paths and simplify them to a relative path.
- * @memberOf module:stringHelpers
- * @param {string} fromFile
- * @param {string} toFile
- * @return {string}
- */
-export declare const makeRelativePath: (fromFile: string, toFile: string) => string;
-export default makeRelativePath;
+/**
+ * Compare two file paths and simplify them to a relative path.
+ * @memberOf module:stringHelpers
+ * @param {string} fromFile - The path of the file the resulting relative path will be used from.
+ * @param {string} toFile - The path of the file being referenced.
+ * @return {string} `toFile` expressed relative to `fromFile`.
+ */
+export declare const makeRelativePath: (fromFile: string, toFile: string) => string;
+export default makeRelativePath;
 //# sourceMappingURL=makeRelativePath.d.ts.map

package/dist/helpers/strings/makeRelativePath.js

@@ -1,43 +1,43 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.makeRelativePath = exports.default = void 0
-var _strBefore = _interopRequireDefault(require('./strBefore'))
-var _strAfter = _interopRequireDefault(require('./strAfter'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Compare two file paths and simplify them to a relative path.
- * @memberOf module:stringHelpers
- * @param {string} fromFile
- * @param {string} toFile
- * @return {string}
- */
-const makeRelativePath = (fromFile, toFile) => {
-  let relativePath = toFile
-  let nextPart = fromFile
-  let firstPart = (0, _strBefore.default)(nextPart, '/')
-  let hasMatches = false
-  while (firstPart && relativePath.startsWith(firstPart)) {
-    relativePath = (0, _strAfter.default)(relativePath, `${firstPart}/`)
-    nextPart = (0, _strAfter.default)(nextPart, `${firstPart}/`)
-    firstPart = (0, _strBefore.default)(nextPart, '/')
-    hasMatches = true
-  }
-  if (!hasMatches) {
-    // No similar base paths, use the path as-is
-    return relativePath
-  }
-  let relativePrefix = ''
-  const nextParts = nextPart.split('/')
-  if (nextParts.length < 2) {
-    relativePrefix = './'
-  }
-  for (let i = 1; i < nextParts.length; ++i) {
-    relativePrefix += '../'
-  }
-  return relativePrefix + relativePath
-}
-exports.makeRelativePath = makeRelativePath
-var _default = exports.default = makeRelativePath
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.makeRelativePath = exports.default = void 0
+var _strBefore = _interopRequireDefault(require('./strBefore'))
+var _strAfter = _interopRequireDefault(require('./strAfter'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Compare two file paths and simplify them to a relative path.
+ * @memberOf module:stringHelpers
+ * @param {string} fromFile - The path of the file the resulting relative path will be used from.
+ * @param {string} toFile - The path of the file being referenced.
+ * @return {string} `toFile` expressed relative to `fromFile`.
+ */
+const makeRelativePath = (fromFile, toFile) => {
+  let relativePath = toFile
+  let nextPart = fromFile
+  let firstPart = (0, _strBefore.default)(nextPart, '/')
+  let hasMatches = false
+  while (firstPart && relativePath.startsWith(firstPart)) {
+    relativePath = (0, _strAfter.default)(relativePath, `${firstPart}/`)
+    nextPart = (0, _strAfter.default)(nextPart, `${firstPart}/`)
+    firstPart = (0, _strBefore.default)(nextPart, '/')
+    hasMatches = true
+  }
+  if (!hasMatches) {
+    // No similar base paths, use the path as-is
+    return relativePath
+  }
+  let relativePrefix = ''
+  const nextParts = nextPart.split('/')
+  if (nextParts.length < 2) {
+    relativePrefix = './'
+  }
+  for (let i = 1; i < nextParts.length; ++i) {
+    relativePrefix += '../'
+  }
+  return relativePrefix + relativePath
+}
+exports.makeRelativePath = makeRelativePath
+var _default = exports.default = makeRelativePath

package/dist/helpers/strings/regexEscape.d.ts

@@ -1,9 +1,9 @@
-/**
- * Take a string and escape the regex characters.
- * @memberOf module:stringHelpers
- * @param {string} str
- * @returns {string}
- */
-export declare const regexEscape: (str: string) => string;
-export default regexEscape;
+/**
+ * Take a string and escape the regex characters.
+ * @memberOf module:stringHelpers
+ * @param {string} str - The string to escape, so it can be used literally inside a `RegExp`.
+ * @returns {string}
+ */
+export declare const regexEscape: (str: string) => string;
+export default regexEscape;
 //# sourceMappingURL=regexEscape.d.ts.map

package/dist/helpers/strings/regexEscape.js

@@ -1,15 +1,15 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.regexEscape = exports.default = void 0
-/**
- * Take a string and escape the regex characters.
- * @memberOf module:stringHelpers
- * @param {string} str
- * @returns {string}
- */
-const regexEscape = str => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
-exports.regexEscape = regexEscape
-var _default = exports.default = regexEscape
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.regexEscape = exports.default = void 0
+/**
+ * Take a string and escape the regex characters.
+ * @memberOf module:stringHelpers
+ * @param {string} str - The string to escape, so it can be used literally inside a `RegExp`.
+ * @returns {string}
+ */
+const regexEscape = str => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
+exports.regexEscape = regexEscape
+var _default = exports.default = regexEscape

package/dist/helpers/strings/snakeCase.d.ts

@@ -1,10 +1,10 @@
-import 'core-js/stable';
-/**
- * Given a string in kebab-case, camelCase or 'Sentence case', convert to snake_case.
- * @memberOf module:stringHelpers
- * @param {string} str
- * @returns {string}
- */
-declare const snakeCase: (str: string) => string;
-export default snakeCase;
+import 'core-js/stable';
+/**
+ * Given a string in kebab-case, camelCase or 'Sentence case', convert to snake_case.
+ * @memberOf module:stringHelpers
+ * @param {string} str - The string to convert.
+ * @returns {string}
+ */
+declare const snakeCase: (str: string) => string;
+export default snakeCase;
 //# sourceMappingURL=snakeCase.d.ts.map