si-funciona 2.3.3 → 2.4.0

package/dist/helpers/descriptors.js

@@ -1,42 +1,58 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-var _assignDescriptor = _interopRequireDefault(require('./descriptors/assignDescriptor'))
-var _assignDescriptorDetail = _interopRequireDefault(require('./descriptors/assignDescriptorDetail'))
-var _checkClearValues = _interopRequireDefault(require('./descriptors/checkClearValues'))
-var _checkDescriptorComplete = _interopRequireDefault(require('./descriptors/checkDescriptorComplete'))
-var _cloneDescriptor = _interopRequireDefault(require('./descriptors/cloneDescriptor'))
-var _cloneDescriptorDetail = _interopRequireDefault(require('./descriptors/cloneDescriptorDetail'))
-var _compareDescriptor = _interopRequireDefault(require('./descriptors/compareDescriptor'))
-var _describeObject = _interopRequireDefault(require('./descriptors/describeObject'))
-var _describeObjectMap = _interopRequireDefault(require('./descriptors/describeObjectMap'))
-var _describeObjectDetail = _interopRequireDefault(require('./descriptors/describeObjectDetail'))
-var _nextReference = _interopRequireDefault(require('./descriptors/nextReference'))
-var _sameDescriptor = _interopRequireDefault(require('./descriptors/sameDescriptor'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Create a format to standardize every object into a specific template.
- * @file
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @module objectDescriptors
- * @memberOf module:siFunciona
- */
-var _default = exports.default = {
-  assignDescriptor: _assignDescriptor.default,
-  assignDescriptorDetail: _assignDescriptorDetail.default,
-  checkClearValues: _checkClearValues.default,
-  checkDescriptorComplete: _checkDescriptorComplete.default,
-  cloneDescriptor: _cloneDescriptor.default,
-  cloneDescriptorDetail: _cloneDescriptorDetail.default,
-  compareDescriptor: _compareDescriptor.default,
-  describeObject: _describeObject.default,
-  describeObjectMap: _describeObjectMap.default,
-  describeObjectDetail: _describeObjectDetail.default,
-  nextReference: _nextReference.default,
-  sameDescriptor: _sameDescriptor.default
-}
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+var _assignDescriptor = _interopRequireDefault(require('./descriptors/assignDescriptor'))
+var _assignDescriptorDetail = _interopRequireDefault(require('./descriptors/assignDescriptorDetail'))
+var _checkClearValues = _interopRequireDefault(require('./descriptors/checkClearValues'))
+var _checkDescriptorComplete = _interopRequireDefault(require('./descriptors/checkDescriptorComplete'))
+var _cloneDescriptor = _interopRequireDefault(require('./descriptors/cloneDescriptor'))
+var _cloneDescriptorDetail = _interopRequireDefault(require('./descriptors/cloneDescriptorDetail'))
+var _compareDescriptor = _interopRequireDefault(require('./descriptors/compareDescriptor'))
+var _describeObject = _interopRequireDefault(require('./descriptors/describeObject'))
+var _describeObjectMap = _interopRequireDefault(require('./descriptors/describeObjectMap'))
+var _describeObjectDetail = _interopRequireDefault(require('./descriptors/describeObjectDetail'))
+var _nextReference = _interopRequireDefault(require('./descriptors/nextReference'))
+var _sameDescriptor = _interopRequireDefault(require('./descriptors/sameDescriptor'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * A "descriptor" is a flat, serializable snapshot of an object or array's shape: for each property, its type(s),
+ * whether it's nullable, and - if the property's own value is itself an object/array - a reference to that nested
+ * value's own descriptor elsewhere in the same list, rather than nesting descriptors inside descriptors. This flat,
+ * reference-based structure is what lets these utilities walk deeply nested and even circular object graphs (an
+ * object that contains itself, directly or indirectly) without infinite recursion, since a value that's already
+ * been described is simply pointed to again instead of re-described.
+ *
+ * Start with {@link module:objectDescriptors.describeObjectMap}, which takes any real object or array and produces
+ * this flat list of descriptors for you - the other functions here (comparing, merging, cloning descriptors) are
+ * building blocks used internally, or useful once you already have descriptors to work with directly.
+ *
+ * The concrete use this module has earned its keep on: describing two objects and comparing the results tells
+ * you whether they're the same shape and values even when they're different references entirely (see
+ * {@link module:objectDescriptors.sameDescriptor}/{@link module:objectDescriptors.compareDescriptor}) - useful
+ * anywhere you need to check that two objects genuinely match without caring whether they're literally the same
+ * instance. A descriptor also doubles as a flat, structured summary of an object's shape, which can be handy for
+ * discussion or assessment purposes (e.g. describing what an object looks like without dumping the whole thing).
+ * @file
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @module objectDescriptors
+ * @memberOf module:siFunciona
+ */
+var _default = exports.default = {
+  assignDescriptor: _assignDescriptor.default,
+  assignDescriptorDetail: _assignDescriptorDetail.default,
+  checkClearValues: _checkClearValues.default,
+  checkDescriptorComplete: _checkDescriptorComplete.default,
+  cloneDescriptor: _cloneDescriptor.default,
+  cloneDescriptorDetail: _cloneDescriptorDetail.default,
+  compareDescriptor: _compareDescriptor.default,
+  describeObject: _describeObject.default,
+  describeObjectMap: _describeObjectMap.default,
+  describeObjectDetail: _describeObjectDetail.default,
+  nextReference: _nextReference.default,
+  sameDescriptor: _sameDescriptor.default
+}

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

@@ -1,12 +1,12 @@
-import 'core-js/stable';
-/**
- * Given a function, call with the correct number of parameters from an array of possible parameters.
- * @memberOf module:functionHelpers
- * @param {Function} fn - The function to be called
- * @param {Array} params - Array of possible function parameters
- * @param {number} [minimum=2] - Minimum number of parameters to use in the function
- * @returns {*}
- */
-declare const callWithParams: (fn: Function, params?: Array<any>, minimum?: number) => any;
-export default callWithParams;
+import 'core-js/stable';
+/**
+ * Given a function, call with the correct number of parameters from an array of possible parameters.
+ * @memberOf module:functionHelpers
+ * @param {Function} fn - The function to be called
+ * @param {Array} params - Array of possible function parameters
+ * @param {number} [minimum=2] - Minimum number of parameters to use in the function
+ * @returns {*}
+ */
+declare const callWithParams: (fn: Function, params?: Array<any>, minimum?: number) => any;
+export default callWithParams;
 //# sourceMappingURL=callWithParams.d.ts.map

package/dist/helpers/functions/callWithParams.js

@@ -1,17 +1,17 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-/**
- * Given a function, call with the correct number of parameters from an array of possible parameters.
- * @memberOf module:functionHelpers
- * @param {Function} fn - The function to be called
- * @param {Array} params - Array of possible function parameters
- * @param {number} [minimum=2] - Minimum number of parameters to use in the function
- * @returns {*}
- */
-const callWithParams = (fn, params = [], minimum = 2) => fn(...params.slice(0, fn.length || minimum))
-var _default = exports.default = callWithParams
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+/**
+ * Given a function, call with the correct number of parameters from an array of possible parameters.
+ * @memberOf module:functionHelpers
+ * @param {Function} fn - The function to be called
+ * @param {Array} params - Array of possible function parameters
+ * @param {number} [minimum=2] - Minimum number of parameters to use in the function
+ * @returns {*}
+ */
+const callWithParams = (fn, params = [], minimum = 2) => fn(...params.slice(0, fn.length || minimum))
+var _default = exports.default = callWithParams

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

@@ -1,12 +1,12 @@
-import 'core-js/stable';
-/**
- * Return a curried version of the passed function.
- * The returned function expects the same number of arguments minus the ones provided.
- * fn is the name of the function being curried.
- * @memberOf module:functionHelpers
- * @param {Function} fn - Receives a function to be curried
- * @returns {Function|*}
- */
-declare const curry: (fn: Function) => Function | any;
-export default curry;
+import 'core-js/stable';
+/**
+ * Return a curried version of the passed function.
+ * The returned function expects the same number of arguments minus the ones provided.
+ * fn is the name of the function being curried.
+ * @memberOf module:functionHelpers
+ * @param {Function} fn - Receives a function to be curried
+ * @returns {Function|*}
+ */
+declare const curry: (fn: Function) => Function | any;
+export default curry;
 //# sourceMappingURL=curry.d.ts.map

package/dist/helpers/functions/curry.js

@@ -1,17 +1,17 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-/**
- * Return a curried version of the passed function.
- * The returned function expects the same number of arguments minus the ones provided.
- * fn is the name of the function being curried.
- * @memberOf module:functionHelpers
- * @param {Function} fn - Receives a function to be curried
- * @returns {Function|*}
- */
-const curry = fn => (...args) => args.length >= fn.length ? fn(...args) : (...a) => curry(fn)(...[...args, ...a])
-var _default = exports.default = curry
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+/**
+ * Return a curried version of the passed function.
+ * The returned function expects the same number of arguments minus the ones provided.
+ * fn is the name of the function being curried.
+ * @memberOf module:functionHelpers
+ * @param {Function} fn - Receives a function to be curried
+ * @returns {Function|*}
+ */
+const curry = fn => (...args) => args.length >= fn.length ? fn(...args) : (...a) => curry(fn)(...[...args, ...a])
+var _default = exports.default = curry

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

@@ -1,22 +1,22 @@
-import 'core-js/stable';
-import 'regenerator-runtime/runtime';
-/**
- * Provide a way to cancel a request or attach a resolve event.
- * @typedef {Object} module:functionHelpers~delayHandler
- * @memberOf module:functionHelpers
- * @property {Promise} resolver
- * @property {Function} cancel
- */
-type delayHandler = {
-    resolver: Promise<any>;
-    cancel: () => void;
-};
-/**
- * Provide a timeout which returns a promise.
- * @memberOf module:functionHelpers
- * @param {number} time - Delay in milliseconds
- * @returns {module:functionHelpers~delayHandler}
- */
-declare const delay: (time?: number) => delayHandler;
-export default delay;
+import 'core-js/stable';
+import 'regenerator-runtime/runtime';
+/**
+ * Provide a way to cancel a request or attach a resolve event.
+ * @typedef {Object} module:functionHelpers~delayHandler
+ * @memberOf module:functionHelpers
+ * @property {Promise} resolver
+ * @property {Function} cancel
+ */
+type delayHandler = {
+    resolver: Promise<any>;
+    cancel: () => void;
+};
+/**
+ * Provide a timeout which returns a promise.
+ * @memberOf module:functionHelpers
+ * @param {number} time - Delay in milliseconds
+ * @returns {module:functionHelpers~delayHandler}
+ */
+declare const delay: (time?: number) => delayHandler;
+export default delay;
 //# sourceMappingURL=delay.d.ts.map

package/dist/helpers/functions/delay.js

@@ -1,32 +1,32 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-require('regenerator-runtime/runtime')
-/**
- * Provide a timeout which returns a promise.
- * @memberOf module:functionHelpers
- * @param {number} time - Delay in milliseconds
- * @returns {module:functionHelpers~delayHandler}
- */
-const delay = (time = 0) => {
-  let cancel = () => undefined
-  return {
-    resolver: new Promise((resolve, reject) => {
-      if (isNaN(time)) {
-        reject(new Error(`Invalid delay: ${time}`))
-      } else {
-        const timeoutId = setTimeout(resolve, time, `Delayed for: ${time}`)
-        cancel = () => {
-          clearTimeout(timeoutId)
-          reject(new Error(`Cancelled delay: ${time}`))
-        }
-      }
-    }),
-    cancel: cancel
-  }
-}
-var _default = exports.default = delay
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+require('regenerator-runtime/runtime')
+/**
+ * Provide a timeout which returns a promise.
+ * @memberOf module:functionHelpers
+ * @param {number} time - Delay in milliseconds
+ * @returns {module:functionHelpers~delayHandler}
+ */
+const delay = (time = 0) => {
+  let cancel = () => undefined
+  return {
+    resolver: new Promise((resolve, reject) => {
+      if (isNaN(time)) {
+        reject(new Error(`Invalid delay: ${time}`))
+      } else {
+        const timeoutId = setTimeout(resolve, time, `Delayed for: ${time}`)
+        cancel = () => {
+          clearTimeout(timeoutId)
+          reject(new Error(`Cancelled delay: ${time}`))
+        }
+      }
+    }),
+    cancel: cancel
+  }
+}
+var _default = exports.default = delay

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

@@ -1,11 +1,11 @@
-import 'core-js/stable';
-import { IsQueue, queuedItem } from '../arrays/BasicQueue';
-/**
- * Create an instance of a basic queue.
- * @memberOf module:functionHelpers
- * @param {Array} initialQueue
- * @returns {IsQueue}
- */
-declare const makeBasicQueue: (initialQueue?: queuedItem[] | any) => IsQueue<any>;
-export default makeBasicQueue;
+import 'core-js/stable';
+import { IsQueue, queuedItem } from '../arrays/BasicQueue';
+/**
+ * Create an instance of a basic queue.
+ * @memberOf module:functionHelpers
+ * @param {Array} [initialQueue=[]] - Items to pre-populate the queue with, in order.
+ * @returns {IsQueue}
+ */
+declare const makeBasicQueue: (initialQueue?: queuedItem[] | any) => IsQueue<any>;
+export default makeBasicQueue;
 //# sourceMappingURL=makeBasicQueue.d.ts.map

package/dist/helpers/functions/makeBasicQueue.js

@@ -1,19 +1,19 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-var _BasicQueue = _interopRequireDefault(require('../arrays/BasicQueue'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Create an instance of a basic queue.
- * @memberOf module:functionHelpers
- * @param {Array} initialQueue
- * @returns {IsQueue}
- */
-const makeBasicQueue = (initialQueue = []) => {
-  return new _BasicQueue.default(initialQueue)
-}
-var _default = exports.default = makeBasicQueue
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+var _BasicQueue = _interopRequireDefault(require('../arrays/BasicQueue'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Create an instance of a basic queue.
+ * @memberOf module:functionHelpers
+ * @param {Array} [initialQueue=[]] - Items to pre-populate the queue with, in order.
+ * @returns {IsQueue}
+ */
+const makeBasicQueue = (initialQueue = []) => {
+  return new _BasicQueue.default(initialQueue)
+}
+var _default = exports.default = makeBasicQueue

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

@@ -1,11 +1,11 @@
-import 'core-js/stable';
-/**
- * Prepare functions to be called once the body is available.
- * @memberOf module:functionHelpers
- * @param {Function} callback
- * @param {boolean} [reset=false]
- * @returns {Array.<Function>}
- */
-declare const onBodyLoad: (callback: Function, reset?: boolean) => Array<Function>;
-export default onBodyLoad;
+import 'core-js/stable';
+/**
+ * Prepare functions to be called once the body is available.
+ * @memberOf module:functionHelpers
+ * @param {Function} callback
+ * @param {boolean} [reset=false]
+ * @returns {Array.<Function>}
+ */
+declare const onBodyLoad: (callback: Function, reset?: boolean) => Array<Function>;
+export default onBodyLoad;
 //# sourceMappingURL=onBodyLoad.d.ts.map

package/dist/helpers/functions/onBodyLoad.js

@@ -1,74 +1,74 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-var _queueManager = _interopRequireDefault(require('./queueManager'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-var __awaiter = void 0 && (void 0).__awaiter || function (thisArg, _arguments, P, generator) {
-  function adopt (value) {
-    return value instanceof P ? value : new P(function (resolve) {
-      resolve(value)
-    })
-  }
-  return new (P || (P = Promise))(function (resolve, reject) {
-    function fulfilled (value) {
-      try {
-        step(generator.next(value))
-      } catch (e) {
-        reject(e)
-      }
-    }
-    function rejected (value) {
-      try {
-        step(generator.throw(value))
-      } catch (e) {
-        reject(e)
-      }
-    }
-    function step (result) {
-      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected)
-    }
-    step((generator = generator.apply(thisArg, _arguments || [])).next())
-  })
-}
-const queue = []
-const manager = (0, _queueManager.default)()
-manager.start()
-let observer = null
-const doReset = () => observer = null
-const initializeObserver = () => __awaiter(void 0, void 0, void 0, function * () {
-  observer = new MutationObserver(() => {
-    if (document.body) {
-      while (queue.length) {
-        manager.push(queue.shift())
-      }
-      observer.disconnect()
-      doReset()
-    }
-  })
-  observer.observe(document.documentElement, {
-    childList: true
-  })
-  return observer
-})
-/**
- * Prepare functions to be called once the body is available.
- * @memberOf module:functionHelpers
- * @param {Function} callback
- * @param {boolean} [reset=false]
- * @returns {Array.<Function>}
- */
-const onBodyLoad = (callback, reset = false) => {
-  if (reset) {
-    doReset()
-  }
-  queue.push(callback)
-  if (observer === null) {
-    initializeObserver()
-  }
-  return queue
-}
-var _default = exports.default = onBodyLoad
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+var _queueManager = _interopRequireDefault(require('./queueManager'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+var __awaiter = void 0 && (void 0).__awaiter || function (thisArg, _arguments, P, generator) {
+  function adopt (value) {
+    return value instanceof P ? value : new P(function (resolve) {
+      resolve(value)
+    })
+  }
+  return new (P || (P = Promise))(function (resolve, reject) {
+    function fulfilled (value) {
+      try {
+        step(generator.next(value))
+      } catch (e) {
+        reject(e)
+      }
+    }
+    function rejected (value) {
+      try {
+        step(generator.throw(value))
+      } catch (e) {
+        reject(e)
+      }
+    }
+    function step (result) {
+      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected)
+    }
+    step((generator = generator.apply(thisArg, _arguments || [])).next())
+  })
+}
+const queue = []
+const manager = (0, _queueManager.default)()
+manager.start()
+let observer = null
+const doReset = () => observer = null
+const initializeObserver = () => __awaiter(void 0, void 0, void 0, function * () {
+  observer = new MutationObserver(() => {
+    if (document.body) {
+      while (queue.length) {
+        manager.push(queue.shift())
+      }
+      observer.disconnect()
+      doReset()
+    }
+  })
+  observer.observe(document.documentElement, {
+    childList: true
+  })
+  return observer
+})
+/**
+ * Prepare functions to be called once the body is available.
+ * @memberOf module:functionHelpers
+ * @param {Function} callback
+ * @param {boolean} [reset=false]
+ * @returns {Array.<Function>}
+ */
+const onBodyLoad = (callback, reset = false) => {
+  if (reset) {
+    doReset()
+  }
+  queue.push(callback)
+  if (observer === null) {
+    initializeObserver()
+  }
+  return queue
+}
+var _default = exports.default = onBodyLoad

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

@@ -1,11 +1,11 @@
-import 'core-js/stable';
-/**
- * Take one or more function with a single parameter and return value.
- * Pass a parameter and the value will be transformed by each function then returned.
- * @memberOf module:functionHelpers
- * @param {...Function} fns - Takes a series of functions having the same parameter
- * @returns {*}
- */
-declare const pipe: (...fns: Function[]) => any;
-export default pipe;
+import 'core-js/stable';
+/**
+ * Take one or more function with a single parameter and return value.
+ * Pass a parameter and the value will be transformed by each function then returned.
+ * @memberOf module:functionHelpers
+ * @param {...Function} fns - Takes a series of functions having the same parameter
+ * @returns {*}
+ */
+declare const pipe: (...fns: Function[]) => any;
+export default pipe;
 //# sourceMappingURL=pipe.d.ts.map

package/dist/helpers/functions/pipe.js

@@ -1,18 +1,18 @@
-'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')
-/**
- * Take one or more function with a single parameter and return value.
- * Pass a parameter and the value will be transformed by each function then returned.
- * @memberOf module:functionHelpers
- * @param {...Function} fns - Takes a series of functions having the same parameter
- * @returns {*}
- */
-const pipe = (...fns) => x => fns.reduce((y, f) => f(y), x)
-var _default = exports.default = pipe
+'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')
+/**
+ * Take one or more function with a single parameter and return value.
+ * Pass a parameter and the value will be transformed by each function then returned.
+ * @memberOf module:functionHelpers
+ * @param {...Function} fns - Takes a series of functions having the same parameter
+ * @returns {*}
+ */
+const pipe = (...fns) => x => fns.reduce((y, f) => f(y), x)
+var _default = exports.default = pipe