si-funciona 2.6.1 → 2.7.0

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

@@ -1,13 +1,14 @@
-/**
- * Create a single random number within provided range. And with optional offset,
- * The distance between the result numbers can be adjusted with interval.
- * @memberOf module:numberHelpers
- * @param {number} range - Choose the breadth of the random number (0-100 would be 100 for range)
- * @param {number} [offset=0] - Choose the starting number (1-10 would be 1 for offset, 9 for range)
- * @param {number} [interval=1] - Choose the distance between numbers (~5, ~10, ~15 would be 5 for interval, 1 for
- * offset, 2 for range)
- * @returns {number}
- */
-declare const randomNumber: (range: number, offset?: number, interval?: number) => number;
-export default randomNumber;
+/**
+ * Create a single random number from offset up to (but never including) offset + range. With optional offset,
+ * the distance between the result numbers can be adjusted with interval. Matches randomInteger, which gives the
+ * whole numbers of the same span.
+ * @memberOf module:numberHelpers
+ * @param {number} range - Choose the breadth of the random number (0 up to, but not including, 100 would be 100 for range)
+ * @param {number} [offset=0] - Choose the starting number (1 up to, but not including, 10 would be 1 for offset, 9 for range)
+ * @param {number} [interval=1] - Choose the multiplier applied to the result (~5, ~10, ~15 would be 5 for interval,
+ * 1 for offset, 2 for range)
+ * @returns {number}
+ */
+declare const randomNumber: (range: number, offset?: number, interval?: number) => number;
+export default randomNumber;
 //# sourceMappingURL=randomNumber.d.ts.map

package/dist/helpers/numbers/randomNumber.js

@@ -1,18 +1,19 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-/**
- * Create a single random number within provided range. And with optional offset,
- * The distance between the result numbers can be adjusted with interval.
- * @memberOf module:numberHelpers
- * @param {number} range - Choose the breadth of the random number (0-100 would be 100 for range)
- * @param {number} [offset=0] - Choose the starting number (1-10 would be 1 for offset, 9 for range)
- * @param {number} [interval=1] - Choose the distance between numbers (~5, ~10, ~15 would be 5 for interval, 1 for
- * offset, 2 for range)
- * @returns {number}
- */
-const randomNumber = (range, offset = 0, interval = 1) => (Math.random() * range + offset) * interval
-const _default = exports.default = randomNumber
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+/**
+ * Create a single random number from offset up to (but never including) offset + range. With optional offset,
+ * the distance between the result numbers can be adjusted with interval. Matches randomInteger, which gives the
+ * whole numbers of the same span.
+ * @memberOf module:numberHelpers
+ * @param {number} range - Choose the breadth of the random number (0 up to, but not including, 100 would be 100 for range)
+ * @param {number} [offset=0] - Choose the starting number (1 up to, but not including, 10 would be 1 for offset, 9 for range)
+ * @param {number} [interval=1] - Choose the multiplier applied to the result (~5, ~10, ~15 would be 5 for interval,
+ * 1 for offset, 2 for range)
+ * @returns {number}
+ */
+const randomNumber = (range, offset = 0, interval = 1) => (Math.random() * range + offset) * interval
+const _default = exports.default = randomNumber

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

@@ -1,9 +1,9 @@
-/**
- * Reduce several numbers to their simplest form / ratio
- * @memberOf module:numberHelpers
- * @param {...number} numbers - Array of numbers to simplify
- * @returns {Array.<number>}
- */
-declare const simplestRatio: (...numbers: number[]) => number[];
-export default simplestRatio;
+/**
+ * Reduce several numbers to their simplest form / ratio
+ * @memberOf module:numberHelpers
+ * @param {...number} numbers - Array of numbers to simplify
+ * @returns {Array.<number>}
+ */
+declare const simplestRatio: (...numbers: number[]) => number[];
+export default simplestRatio;
 //# sourceMappingURL=simplestRatio.d.ts.map

package/dist/helpers/numbers/simplestRatio.js

@@ -1,28 +1,28 @@
-'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.map.js')
-require('core-js/modules/esnext.iterator.reduce.js')
-const _greatestCommonDivisor = _interopRequireDefault(require('./greatestCommonDivisor'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Reduce several numbers to their simplest form / ratio
- * @memberOf module:numberHelpers
- * @param {...number} numbers - Array of numbers to simplify
- * @returns {Array.<number>}
- */
-const simplestRatio = (...numbers) => {
-  if (numbers.length === 0) {
-    return []
-  }
-  let commonDivisor = numbers.reduce((num1, num2) => (0, _greatestCommonDivisor.default)(num1, num2), 0)
-  // Set to positive so that when we divide the numbers they retain their +/-
-  commonDivisor = Math.abs(commonDivisor)
-  // Simplify the numbers, handle zero
-  return numbers.map(num => commonDivisor === 0 ? 0 : num / commonDivisor)
-}
-const _default = exports.default = simplestRatio
+'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.map.js')
+require('core-js/modules/esnext.iterator.reduce.js')
+const _greatestCommonDivisor = _interopRequireDefault(require('./greatestCommonDivisor'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Reduce several numbers to their simplest form / ratio
+ * @memberOf module:numberHelpers
+ * @param {...number} numbers - Array of numbers to simplify
+ * @returns {Array.<number>}
+ */
+const simplestRatio = (...numbers) => {
+  if (numbers.length === 0) {
+    return []
+  }
+  let commonDivisor = numbers.reduce((num1, num2) => (0, _greatestCommonDivisor.default)(num1, num2), 0)
+  // Set to positive so that when we divide the numbers they retain their +/-
+  commonDivisor = Math.abs(commonDivisor)
+  // Simplify the numbers, handle zero
+  return numbers.map(num => commonDivisor === 0 ? 0 : num / commonDivisor)
+}
+const _default = exports.default = simplestRatio

package/dist/helpers/numbers.d.ts

@@ -1,31 +1,31 @@
-/**
- * Some number comparators and random number generators.
- * @file
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @module numberHelpers
- * @memberOf module:siFunciona
- */
-import absoluteMax from './numbers/absoluteMax';
-import absoluteMin from './numbers/absoluteMin';
-import compare from './numbers/compare';
-import greatestCommonDivisor from './numbers/greatestCommonDivisor';
-import leastCommonMultiple from './numbers/leastCommonMultiple';
-import lowestCommonDenominator from './numbers/lowestCommonDenominator';
-import randomInteger from './numbers/randomInteger';
-import randomNumber from './numbers/randomNumber';
-import simplestRatio from './numbers/simplestRatio';
-export { absoluteMax, absoluteMin, compare, greatestCommonDivisor, leastCommonMultiple, lowestCommonDenominator, randomInteger, randomNumber, simplestRatio };
-declare const _default: {
-    absoluteMax: (num1: number, num2: number) => number;
-    absoluteMin: (num1: number, num2: number) => number;
-    compare: (val1: number, val2: number) => number;
-    greatestCommonDivisor: (num1: number, num2: number) => number;
-    leastCommonMultiple: (num1: number, num2: number) => number;
-    lowestCommonDenominator: (...numbers: number[]) => number;
-    randomInteger: (range: number, offset?: number, interval?: number) => number;
-    randomNumber: (range: number, offset?: number, interval?: number) => number;
-    simplestRatio: (...numbers: number[]) => number[];
-};
-export default _default;
+/**
+ * Some number comparators and random number generators.
+ * @file
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @module numberHelpers
+ * @memberOf module:siFunciona
+ */
+import absoluteMax from './numbers/absoluteMax';
+import absoluteMin from './numbers/absoluteMin';
+import compare from './numbers/compare';
+import greatestCommonDivisor from './numbers/greatestCommonDivisor';
+import leastCommonMultiple from './numbers/leastCommonMultiple';
+import lowestCommonDenominator from './numbers/lowestCommonDenominator';
+import randomInteger from './numbers/randomInteger';
+import randomNumber from './numbers/randomNumber';
+import simplestRatio from './numbers/simplestRatio';
+export { absoluteMax, absoluteMin, compare, greatestCommonDivisor, leastCommonMultiple, lowestCommonDenominator, randomInteger, randomNumber, simplestRatio };
+declare const _default: {
+    absoluteMax: (num1: number, num2: number) => number;
+    absoluteMin: (num1: number, num2: number) => number;
+    compare: (val1: number, val2: number) => number;
+    greatestCommonDivisor: (num1: number, num2: number) => number;
+    leastCommonMultiple: (num1: number, num2: number) => number;
+    lowestCommonDenominator: (...numbers: number[]) => number;
+    randomInteger: (range: number, offset?: number, interval?: number) => number;
+    randomNumber: (range: number, offset?: number, interval?: number) => number;
+    simplestRatio: (...numbers: number[]) => number[];
+};
+export default _default;
 //# sourceMappingURL=numbers.d.ts.map

package/dist/helpers/numbers.js

@@ -1,89 +1,89 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-Object.defineProperty(exports, 'absoluteMax', {
-  enumerable: true,
-  get: function () {
-    return _absoluteMax.default
-  }
-})
-Object.defineProperty(exports, 'absoluteMin', {
-  enumerable: true,
-  get: function () {
-    return _absoluteMin.default
-  }
-})
-Object.defineProperty(exports, 'compare', {
-  enumerable: true,
-  get: function () {
-    return _compare.default
-  }
-})
-exports.default = void 0
-Object.defineProperty(exports, 'greatestCommonDivisor', {
-  enumerable: true,
-  get: function () {
-    return _greatestCommonDivisor.default
-  }
-})
-Object.defineProperty(exports, 'leastCommonMultiple', {
-  enumerable: true,
-  get: function () {
-    return _leastCommonMultiple.default
-  }
-})
-Object.defineProperty(exports, 'lowestCommonDenominator', {
-  enumerable: true,
-  get: function () {
-    return _lowestCommonDenominator.default
-  }
-})
-Object.defineProperty(exports, 'randomInteger', {
-  enumerable: true,
-  get: function () {
-    return _randomInteger.default
-  }
-})
-Object.defineProperty(exports, 'randomNumber', {
-  enumerable: true,
-  get: function () {
-    return _randomNumber.default
-  }
-})
-Object.defineProperty(exports, 'simplestRatio', {
-  enumerable: true,
-  get: function () {
-    return _simplestRatio.default
-  }
-})
-var _absoluteMax = _interopRequireDefault(require('./numbers/absoluteMax'))
-var _absoluteMin = _interopRequireDefault(require('./numbers/absoluteMin'))
-var _compare = _interopRequireDefault(require('./numbers/compare'))
-var _greatestCommonDivisor = _interopRequireDefault(require('./numbers/greatestCommonDivisor'))
-var _leastCommonMultiple = _interopRequireDefault(require('./numbers/leastCommonMultiple'))
-var _lowestCommonDenominator = _interopRequireDefault(require('./numbers/lowestCommonDenominator'))
-var _randomInteger = _interopRequireDefault(require('./numbers/randomInteger'))
-var _randomNumber = _interopRequireDefault(require('./numbers/randomNumber'))
-var _simplestRatio = _interopRequireDefault(require('./numbers/simplestRatio'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Some number comparators and random number generators.
- * @file
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @module numberHelpers
- * @memberOf module:siFunciona
- */
-const _default = exports.default = {
-  absoluteMax: _absoluteMax.default,
-  absoluteMin: _absoluteMin.default,
-  compare: _compare.default,
-  greatestCommonDivisor: _greatestCommonDivisor.default,
-  leastCommonMultiple: _leastCommonMultiple.default,
-  lowestCommonDenominator: _lowestCommonDenominator.default,
-  randomInteger: _randomInteger.default,
-  randomNumber: _randomNumber.default,
-  simplestRatio: _simplestRatio.default
-}
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+Object.defineProperty(exports, 'absoluteMax', {
+  enumerable: true,
+  get: function () {
+    return _absoluteMax.default
+  }
+})
+Object.defineProperty(exports, 'absoluteMin', {
+  enumerable: true,
+  get: function () {
+    return _absoluteMin.default
+  }
+})
+Object.defineProperty(exports, 'compare', {
+  enumerable: true,
+  get: function () {
+    return _compare.default
+  }
+})
+exports.default = void 0
+Object.defineProperty(exports, 'greatestCommonDivisor', {
+  enumerable: true,
+  get: function () {
+    return _greatestCommonDivisor.default
+  }
+})
+Object.defineProperty(exports, 'leastCommonMultiple', {
+  enumerable: true,
+  get: function () {
+    return _leastCommonMultiple.default
+  }
+})
+Object.defineProperty(exports, 'lowestCommonDenominator', {
+  enumerable: true,
+  get: function () {
+    return _lowestCommonDenominator.default
+  }
+})
+Object.defineProperty(exports, 'randomInteger', {
+  enumerable: true,
+  get: function () {
+    return _randomInteger.default
+  }
+})
+Object.defineProperty(exports, 'randomNumber', {
+  enumerable: true,
+  get: function () {
+    return _randomNumber.default
+  }
+})
+Object.defineProperty(exports, 'simplestRatio', {
+  enumerable: true,
+  get: function () {
+    return _simplestRatio.default
+  }
+})
+var _absoluteMax = _interopRequireDefault(require('./numbers/absoluteMax'))
+var _absoluteMin = _interopRequireDefault(require('./numbers/absoluteMin'))
+var _compare = _interopRequireDefault(require('./numbers/compare'))
+var _greatestCommonDivisor = _interopRequireDefault(require('./numbers/greatestCommonDivisor'))
+var _leastCommonMultiple = _interopRequireDefault(require('./numbers/leastCommonMultiple'))
+var _lowestCommonDenominator = _interopRequireDefault(require('./numbers/lowestCommonDenominator'))
+var _randomInteger = _interopRequireDefault(require('./numbers/randomInteger'))
+var _randomNumber = _interopRequireDefault(require('./numbers/randomNumber'))
+var _simplestRatio = _interopRequireDefault(require('./numbers/simplestRatio'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Some number comparators and random number generators.
+ * @file
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @module numberHelpers
+ * @memberOf module:siFunciona
+ */
+const _default = exports.default = {
+  absoluteMax: _absoluteMax.default,
+  absoluteMin: _absoluteMin.default,
+  compare: _compare.default,
+  greatestCommonDivisor: _greatestCommonDivisor.default,
+  leastCommonMultiple: _leastCommonMultiple.default,
+  lowestCommonDenominator: _lowestCommonDenominator.default,
+  randomInteger: _randomInteger.default,
+  randomNumber: _randomNumber.default,
+  simplestRatio: _simplestRatio.default
+}

package/dist/helpers/objects/cloneObject.d.ts

@@ -5,14 +5,12 @@ type cloneObjectOptions = {
 };
 /**
  * Clone objects for manipulation without data corruption, returns a copy of the provided object.
- * NOTE: Use the mapLimit and relevancyRange to resolve "too much recursion" when the object is large and is known to
- * have circular references. A high mapLimit may lead to heavy memory usage and slow performance.
  * @memberOf module:objectHelpers
  * @param {Object} object - The original object that is being cloned
  * @param {Object} [options={}]
- * @param {number} [options.mapLimit=100] - Size of temporary reference array used in memory before assessing relevancy.
+ * @param {number} [options.mapLimit=100] - Deprecated and ignored (circular references are handled without trimming).
  * @param {number} [options.depthLimit=-1] - Control how many nested levels deep will be used, -1 = no limit, >-1 = nth level limited.
- * @param {number} [options.relevancyRange=1000] - Total reference map length subtract this range, any relevancy less than that amount at time of evaluation will be removed.
+ * @param {number} [options.relevancyRange=1000] - Deprecated and ignored: see mapLimit.
  * @returns {Object}
  */
 declare const cloneObject: (object: object, { mapLimit, depthLimit, relevancyRange }?: cloneObjectOptions) => object;

package/dist/helpers/objects/cloneObject.js

@@ -8,14 +8,12 @@ const _mergeObjectsBase = _interopRequireDefault(require('./mergeObjectsBase'))
 function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
 /**
  * Clone objects for manipulation without data corruption, returns a copy of the provided object.
- * NOTE: Use the mapLimit and relevancyRange to resolve "too much recursion" when the object is large and is known to
- * have circular references. A high mapLimit may lead to heavy memory usage and slow performance.
  * @memberOf module:objectHelpers
  * @param {Object} object - The original object that is being cloned
  * @param {Object} [options={}]
- * @param {number} [options.mapLimit=100] - Size of temporary reference array used in memory before assessing relevancy.
+ * @param {number} [options.mapLimit=100] - Deprecated and ignored (circular references are handled without trimming).
  * @param {number} [options.depthLimit=-1] - Control how many nested levels deep will be used, -1 = no limit, >-1 = nth level limited.
- * @param {number} [options.relevancyRange=1000] - Total reference map length subtract this range, any relevancy less than that amount at time of evaluation will be removed.
+ * @param {number} [options.relevancyRange=1000] - Deprecated and ignored: see mapLimit.
  * @returns {Object}
  */
 const cloneObject = (object, {

package/dist/helpers/objects/dotGet.d.ts

@@ -1,12 +1,12 @@
-import { dotNotateableItem, dotNotationString } from './dotNotate';
-/**
- * Get a nested property value from an object.
- * @memberOf module:objectHelpers
- * @param {Object} arrayObject - The array or object to get the property from
- * @param {string} dotNotation - The path to the property
- * @param {string|null} [defaultValue=null] - The default value to return if the property is not found
- * @returns {*} The value of the property
- */
-declare const dotGet: (arrayObject: dotNotateableItem, dotNotation: dotNotationString, defaultValue?: string | null) => any;
-export default dotGet;
+import { dotNotateableItem, dotNotationString } from './dotNotate';
+/**
+ * Get a nested property value from an object.
+ * @memberOf module:objectHelpers
+ * @param {Object} arrayObject - The array or object to get the property from
+ * @param {string} dotNotation - The path to the property
+ * @param {string|null} [defaultValue=null] - The default value to return if the property is not found
+ * @returns {*} The value of the property
+ */
+declare const dotGet: (arrayObject: dotNotateableItem, dotNotation: dotNotationString, defaultValue?: string | null) => any;
+export default dotGet;
 //# sourceMappingURL=dotGet.d.ts.map

package/dist/helpers/objects/dotGet.js

@@ -1,59 +1,59 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-const _isObject = _interopRequireDefault(require('./isObject'))
-const _strAfter = _interopRequireDefault(require('../strings/strAfter'))
-const _strBefore = _interopRequireDefault(require('../strings/strBefore'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Get a nested property value from an object.
- * @memberOf module:objectHelpers
- * @param {Object} arrayObject - The array or object to get the property from
- * @param {string} dotNotation - The path to the property
- * @param {string|null} [defaultValue=null] - The default value to return if the property is not found
- * @returns {*} The value of the property
- */
-const dotGet = (arrayObject, dotNotation, defaultValue = null) => {
-  let _a
-  let key = (0, _strBefore.default)(dotNotation, '.')
-  const lastKey = !key
-  if (lastKey) {
-    key = dotNotation
-  }
-  if (key === '*') {
-    const result = []
-    for (const wildKey in arrayObject) {
-      // @ts-ignore
-      const wildValue = arrayObject[wildKey]
-      if (lastKey) {
-        // @ts-ignore
-        result[wildKey] = wildValue
-        continue
-      }
-      if (!(0, _isObject.default)(wildValue)) {
-        continue
-      }
-      // @ts-ignore
-      result[wildKey] = dotGet(wildValue, (0, _strAfter.default)(dotNotation, '.'), defaultValue)
-    }
-    return result
-  }
-  if (lastKey) {
-    // @ts-ignore
-    return (_a = arrayObject[dotNotation]) !== null && _a !== void 0 ? _a : defaultValue
-  }
-  // @ts-ignore
-  if (typeof arrayObject[key] === 'undefined') {
-    return defaultValue
-  }
-  // @ts-ignore
-  const next = arrayObject[key]
-  if (!(0, _isObject.default)(next)) {
-    return defaultValue
-  }
-  return dotGet(next, (0, _strAfter.default)(dotNotation, '.'), defaultValue)
-}
-const _default = exports.default = dotGet
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+const _isObject = _interopRequireDefault(require('./isObject'))
+const _strAfter = _interopRequireDefault(require('../strings/strAfter'))
+const _strBefore = _interopRequireDefault(require('../strings/strBefore'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Get a nested property value from an object.
+ * @memberOf module:objectHelpers
+ * @param {Object} arrayObject - The array or object to get the property from
+ * @param {string} dotNotation - The path to the property
+ * @param {string|null} [defaultValue=null] - The default value to return if the property is not found
+ * @returns {*} The value of the property
+ */
+const dotGet = (arrayObject, dotNotation, defaultValue = null) => {
+  let _a
+  let key = (0, _strBefore.default)(dotNotation, '.')
+  const lastKey = !key
+  if (lastKey) {
+    key = dotNotation
+  }
+  if (key === '*') {
+    const result = []
+    for (const wildKey in arrayObject) {
+      // @ts-ignore
+      const wildValue = arrayObject[wildKey]
+      if (lastKey) {
+        // @ts-ignore
+        result[wildKey] = wildValue
+        continue
+      }
+      if (!(0, _isObject.default)(wildValue)) {
+        continue
+      }
+      // @ts-ignore
+      result[wildKey] = dotGet(wildValue, (0, _strAfter.default)(dotNotation, '.'), defaultValue)
+    }
+    return result
+  }
+  if (lastKey) {
+    // @ts-ignore
+    return (_a = arrayObject[dotNotation]) !== null && _a !== void 0 ? _a : defaultValue
+  }
+  // @ts-ignore
+  if (typeof arrayObject[key] === 'undefined') {
+    return defaultValue
+  }
+  // @ts-ignore
+  const next = arrayObject[key]
+  if (!(0, _isObject.default)(next)) {
+    return defaultValue
+  }
+  return dotGet(next, (0, _strAfter.default)(dotNotation, '.'), defaultValue)
+}
+const _default = exports.default = dotGet

package/dist/helpers/objects/dotNotate.d.ts

@@ -1,28 +1,28 @@
-export type dotNotateableItem = Array<any> | {
-    [k: string]: any;
-};
-/**
- * A string representing the full-path to a property in an object. Each depth of the path is separated by a period.
- * @example 'a.b.c'
- * @typedef {string} DotNotationString
- * @memberOf module:objectHelpers
- */
-export type dotNotationString = string;
-/**
- * An array or object where all properties have been flatted and keyed by a dot-notated string.
- * @typedef {Object.<DotNotationString, *>} DotNotatedObject
- * @memberOf module:objectHelpers
- */
-type dotNotatedObject = {
-    [k: dotNotationString]: any;
-};
-/**
- * Convert an array or object to a single dimensional associative array with dot notation.
- * @memberOf module:objectHelpers
- * @param {Object} arrayObject - The array or object to dot-notate
- * @param {Array.<DotNotationString>} [retainObjects=[]] - An array of keys to retain as objects
- * @returns {DotNotatedObject} The dot-notated object
- */
-declare const dotNotate: (arrayObject: object, retainObjects?: Array<dotNotationString>) => dotNotatedObject;
-export default dotNotate;
+export type dotNotateableItem = Array<any> | {
+    [k: string]: any;
+};
+/**
+ * A string representing the full-path to a property in an object. Each depth of the path is separated by a period.
+ * @example 'a.b.c'
+ * @typedef {string} DotNotationString
+ * @memberOf module:objectHelpers
+ */
+export type dotNotationString = string;
+/**
+ * An array or object where all properties have been flatted and keyed by a dot-notated string.
+ * @typedef {Object.<DotNotationString, *>} DotNotatedObject
+ * @memberOf module:objectHelpers
+ */
+type dotNotatedObject = {
+    [k: dotNotationString]: any;
+};
+/**
+ * Convert an array or object to a single dimensional associative array with dot notation.
+ * @memberOf module:objectHelpers
+ * @param {Object} arrayObject - The array or object to dot-notate
+ * @param {Array.<DotNotationString>} [retainObjects=[]] - An array of keys to retain as objects
+ * @returns {DotNotatedObject} The dot-notated object
+ */
+declare const dotNotate: (arrayObject: object, retainObjects?: Array<dotNotationString>) => dotNotatedObject;
+export default dotNotate;
 //# sourceMappingURL=dotNotate.d.ts.map