si-funciona 2.3.3 → 2.4.0

package/dist/helpers/descriptors/assignDescriptorDetail.js

@@ -1,34 +1,37 @@
-'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 _cloneDescriptorDetail = _interopRequireDefault(require('./cloneDescriptorDetail'))
-var _uniqueArray = _interopRequireDefault(require('../arrays/uniqueArray'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Assign properties from other details onto an existing detail.
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptorDetail} originalDetail
- * @param  {...module:objectDescriptors~descriptorDetail} details
- * @returns {module:objectDescriptors~descriptorDetail}
- */
-const assignDescriptorDetail = (originalDetail, ...details) => details.reduce((existingDetail, newDetail) => {
-  existingDetail.type = (0, _uniqueArray.default)([...existingDetail.type, ...newDetail.type])
-  existingDetail.value = (0, _uniqueArray.default)([...existingDetail.value, ...newDetail.value])
-  existingDetail.nullable = existingDetail.nullable || newDetail.nullable
-  existingDetail.optional = existingDetail.optional || newDetail.optional
-  existingDetail.circular = existingDetail.circular || newDetail.circular
-  existingDetail.isReference = existingDetail.isReference || newDetail.isReference
-  existingDetail.isInstance = existingDetail.isInstance || newDetail.isInstance
-  existingDetail.arrayReference = [existingDetail.arrayReference, newDetail.arrayReference].find(ref => typeof ref === 'number')
-  existingDetail.objectReference = [existingDetail.objectReference, newDetail.objectReference].find(ref => typeof ref === 'number')
-  existingDetail.arrayReference = typeof existingDetail.arrayReference === 'undefined' ? null : existingDetail.arrayReference
-  existingDetail.objectReference = typeof existingDetail.objectReference === 'undefined' ? null : existingDetail.objectReference
-  return existingDetail
-}, (0, _cloneDescriptorDetail.default)(originalDetail))
-var _default = exports.default = assignDescriptorDetail
+'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 _cloneDescriptorDetail = _interopRequireDefault(require('./cloneDescriptorDetail'))
+var _uniqueArray = _interopRequireDefault(require('../arrays/uniqueArray'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Assign properties from other details onto an existing detail, widening it (e.g. combining `type`/`value` arrays,
+ * OR-ing boolean flags like `nullable`/`optional`) rather than overwriting it - the per-property counterpart to
+ * {@link module:objectDescriptors.assignDescriptor}.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptorDetail} originalDetail - The base detail to merge onto (not mutated -
+ * a clone is merged and returned).
+ * @param  {...module:objectDescriptors~descriptorDetail} details - One or more further details to merge in.
+ * @returns {module:objectDescriptors~descriptorDetail} A new detail representing the merge of all of the above.
+ */
+const assignDescriptorDetail = (originalDetail, ...details) => details.reduce((existingDetail, newDetail) => {
+  existingDetail.type = (0, _uniqueArray.default)([...existingDetail.type, ...newDetail.type])
+  existingDetail.value = (0, _uniqueArray.default)([...existingDetail.value, ...newDetail.value])
+  existingDetail.nullable = existingDetail.nullable || newDetail.nullable
+  existingDetail.optional = existingDetail.optional || newDetail.optional
+  existingDetail.circular = existingDetail.circular || newDetail.circular
+  existingDetail.isReference = existingDetail.isReference || newDetail.isReference
+  existingDetail.isInstance = existingDetail.isInstance || newDetail.isInstance
+  existingDetail.arrayReference = [existingDetail.arrayReference, newDetail.arrayReference].find(ref => typeof ref === 'number')
+  existingDetail.objectReference = [existingDetail.objectReference, newDetail.objectReference].find(ref => typeof ref === 'number')
+  existingDetail.arrayReference = typeof existingDetail.arrayReference === 'undefined' ? null : existingDetail.arrayReference
+  existingDetail.objectReference = typeof existingDetail.objectReference === 'undefined' ? null : existingDetail.objectReference
+  return existingDetail
+}, (0, _cloneDescriptorDetail.default)(originalDetail))
+var _default = exports.default = assignDescriptorDetail

package/dist/helpers/descriptors/checkClearValues.d.ts

@@ -1,12 +1,13 @@
-import 'core-js/stable';
-import { descriptor } from './samples/descriptor';
-/**
- * Check if we should clear the values on this descriptor
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptor} descriptor
- * @param {boolean} [keepValues=false]
- * @returns {module:objectDescriptors~descriptor}
- */
-declare const checkClearValues: (descriptor: descriptor, keepValues?: boolean) => descriptor;
-export default checkClearValues;
+import 'core-js/stable';
+import { descriptor } from './samples/descriptor';
+/**
+ * Once a descriptor is complete (all its references have been resolved), its details' actual `value` arrays are no
+ * longer needed to build the descriptor further - clear them to save memory, unless `keepValues` says otherwise.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptor} descriptor - The descriptor to check.
+ * @param {boolean} [keepValues=false] - Set true to keep the values even once the descriptor is complete.
+ * @returns {module:objectDescriptors~descriptor} The same descriptor, with `details[].value` cleared if applicable.
+ */
+declare const checkClearValues: (descriptor: descriptor, keepValues?: boolean) => descriptor;
+export default checkClearValues;
 //# sourceMappingURL=checkClearValues.d.ts.map

package/dist/helpers/descriptors/checkClearValues.js

@@ -1,20 +1,21 @@
-'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/stable')
-var _setValue = _interopRequireDefault(require('../objects/setValue'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Check if we should clear the values on this descriptor
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptor} descriptor
- * @param {boolean} [keepValues=false]
- * @returns {module:objectDescriptors~descriptor}
- */
-const checkClearValues = (descriptor, keepValues = false) => (0, _setValue.default)('details', descriptor.complete && !keepValues ? descriptor.details.map(detail => (0, _setValue.default)('value', [], detail)) : descriptor.details, descriptor)
-var _default = exports.default = checkClearValues
+'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/stable')
+var _setValue = _interopRequireDefault(require('../objects/setValue'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Once a descriptor is complete (all its references have been resolved), its details' actual `value` arrays are no
+ * longer needed to build the descriptor further - clear them to save memory, unless `keepValues` says otherwise.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptor} descriptor - The descriptor to check.
+ * @param {boolean} [keepValues=false] - Set true to keep the values even once the descriptor is complete.
+ * @returns {module:objectDescriptors~descriptor} The same descriptor, with `details[].value` cleared if applicable.
+ */
+const checkClearValues = (descriptor, keepValues = false) => (0, _setValue.default)('details', descriptor.complete && !keepValues ? descriptor.details.map(detail => (0, _setValue.default)('value', [], detail)) : descriptor.details, descriptor)
+var _default = exports.default = checkClearValues

package/dist/helpers/descriptors/checkDescriptorComplete.d.ts

@@ -1,11 +1,12 @@
-import 'core-js/stable';
-import { descriptor } from './samples/descriptor';
-/**
- * Check if the descriptors references have all been built and set complete to true if they have.
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptor} descriptor
- * @returns {module:objectDescriptors~descriptor}
- */
-declare const checkDescriptorComplete: (descriptor: descriptor) => descriptor;
-export default checkDescriptorComplete;
+import 'core-js/stable';
+import { descriptor } from './samples/descriptor';
+/**
+ * Check if every property this descriptor references (i.e. every nested object/array it points to) has actually
+ * had its own descriptor built yet, and set the descriptor's `complete` flag to true if so.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptor} descriptor - The descriptor to check.
+ * @returns {module:objectDescriptors~descriptor} The same descriptor, with `complete` updated.
+ */
+declare const checkDescriptorComplete: (descriptor: descriptor) => descriptor;
+export default checkDescriptorComplete;
 //# sourceMappingURL=checkDescriptorComplete.d.ts.map

package/dist/helpers/descriptors/checkDescriptorComplete.js

@@ -1,19 +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.every.js')
-require('core-js/stable')
-var _setValue = _interopRequireDefault(require('../objects/setValue'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Check if the descriptors references have all been built and set complete to true if they have.
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptor} descriptor
- * @returns {module:objectDescriptors~descriptor}
- */
-const checkDescriptorComplete = descriptor => (0, _setValue.default)('complete', descriptor.references.every(refId => [descriptor.details[refId].arrayReference, descriptor.details[refId].objectReference].some(ref => typeof ref === 'number')), descriptor)
-var _default = exports.default = checkDescriptorComplete
+'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.every.js')
+require('core-js/stable')
+var _setValue = _interopRequireDefault(require('../objects/setValue'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Check if every property this descriptor references (i.e. every nested object/array it points to) has actually
+ * had its own descriptor built yet, and set the descriptor's `complete` flag to true if so.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptor} descriptor - The descriptor to check.
+ * @returns {module:objectDescriptors~descriptor} The same descriptor, with `complete` updated.
+ */
+const checkDescriptorComplete = descriptor => (0, _setValue.default)('complete', descriptor.references.every(refId => [descriptor.details[refId].arrayReference, descriptor.details[refId].objectReference].some(ref => typeof ref === 'number')), descriptor)
+var _default = exports.default = checkDescriptorComplete

package/dist/helpers/descriptors/cloneDescriptor.d.ts

@@ -1,11 +1,11 @@
-import 'core-js/stable';
-import { descriptor } from './samples/descriptor';
-/**
- * Make a copy of an object descriptor so that the original will not be mutated.
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptor} originalMap
- * @returns {module:objectDescriptors~descriptor}
- */
-declare const cloneDescriptor: (originalMap: descriptor) => descriptor;
-export default cloneDescriptor;
+import 'core-js/stable';
+import { descriptor } from './samples/descriptor';
+/**
+ * Make a copy of an object descriptor so that the original will not be mutated.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptor} originalMap - The descriptor to copy.
+ * @returns {module:objectDescriptors~descriptor} A new, independent copy.
+ */
+declare const cloneDescriptor: (originalMap: descriptor) => descriptor;
+export default cloneDescriptor;
 //# sourceMappingURL=cloneDescriptor.d.ts.map

package/dist/helpers/descriptors/cloneDescriptor.js

@@ -1,36 +1,36 @@
-'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/stable')
-var _cloneDescriptorDetail = _interopRequireDefault(require('./cloneDescriptorDetail'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Make a copy of an object descriptor so that the original will not be mutated.
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptor} originalMap
- * @returns {module:objectDescriptors~descriptor}
- */
-const cloneDescriptor = originalMap => {
-  const copyMap = {}
-  // @ts-ignore
-  copyMap.index = originalMap.index || 0
-  // @ts-ignore
-  copyMap.details = originalMap.details.map(_cloneDescriptorDetail.default)
-  // @ts-ignore
-  copyMap.length = originalMap.length
-  // @ts-ignore
-  copyMap.keys = originalMap.keys.map(key => key)
-  // @ts-ignore
-  copyMap.references = originalMap.references.map(reference => reference)
-  // @ts-ignore
-  copyMap.isArray = originalMap.isArray
-  // @ts-ignore
-  copyMap.complete = originalMap.complete
-  return copyMap
-}
-var _default = exports.default = cloneDescriptor
+'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/stable')
+var _cloneDescriptorDetail = _interopRequireDefault(require('./cloneDescriptorDetail'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Make a copy of an object descriptor so that the original will not be mutated.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptor} originalMap - The descriptor to copy.
+ * @returns {module:objectDescriptors~descriptor} A new, independent copy.
+ */
+const cloneDescriptor = originalMap => {
+  const copyMap = {}
+  // @ts-ignore
+  copyMap.index = originalMap.index || 0
+  // @ts-ignore
+  copyMap.details = originalMap.details.map(_cloneDescriptorDetail.default)
+  // @ts-ignore
+  copyMap.length = originalMap.length
+  // @ts-ignore
+  copyMap.keys = originalMap.keys.map(key => key)
+  // @ts-ignore
+  copyMap.references = originalMap.references.map(reference => reference)
+  // @ts-ignore
+  copyMap.isArray = originalMap.isArray
+  // @ts-ignore
+  copyMap.complete = originalMap.complete
+  return copyMap
+}
+var _default = exports.default = cloneDescriptor

package/dist/helpers/descriptors/cloneDescriptorDetail.d.ts

@@ -1,11 +1,11 @@
-import 'core-js/stable';
-import { descriptorDetail } from './samples/descriptorDetail';
-/**
- * Get a new copy of an existing Descriptor Detail
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptorDetail} originalDetail
- * @returns {module:objectDescriptors~descriptorDetail}
- */
-declare const cloneDescriptorDetail: (originalDetail: descriptorDetail) => descriptorDetail;
-export default cloneDescriptorDetail;
+import 'core-js/stable';
+import { descriptorDetail } from './samples/descriptorDetail';
+/**
+ * Get a new copy of an existing descriptor detail so that the original will not be mutated.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptorDetail} originalDetail - The detail to copy.
+ * @returns {module:objectDescriptors~descriptorDetail} A new, independent copy.
+ */
+declare const cloneDescriptorDetail: (originalDetail: descriptorDetail) => descriptorDetail;
+export default cloneDescriptorDetail;
 //# sourceMappingURL=cloneDescriptorDetail.d.ts.map

package/dist/helpers/descriptors/cloneDescriptorDetail.js

@@ -1,27 +1,27 @@
-'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.for-each.js')
-require('core-js/modules/esnext.iterator.map.js')
-require('core-js/stable')
-var _objectKeys = _interopRequireDefault(require('../objects/objectKeys'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Get a new copy of an existing Descriptor Detail
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptorDetail} originalDetail
- * @returns {module:objectDescriptors~descriptorDetail}
- */
-const cloneDescriptorDetail = originalDetail => {
-  const copyDetail = {};
-  (0, _objectKeys.default)(originalDetail).forEach(key => {
-    // @ts-ignore
-    copyDetail[key] = Array.isArray(originalDetail[key]) ? originalDetail[key].map(value => value) : originalDetail[key]
-  })
-  return copyDetail
-}
-var _default = exports.default = cloneDescriptorDetail
+'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.for-each.js')
+require('core-js/modules/esnext.iterator.map.js')
+require('core-js/stable')
+var _objectKeys = _interopRequireDefault(require('../objects/objectKeys'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Get a new copy of an existing descriptor detail so that the original will not be mutated.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptorDetail} originalDetail - The detail to copy.
+ * @returns {module:objectDescriptors~descriptorDetail} A new, independent copy.
+ */
+const cloneDescriptorDetail = originalDetail => {
+  const copyDetail = {};
+  (0, _objectKeys.default)(originalDetail).forEach(key => {
+    // @ts-ignore
+    copyDetail[key] = Array.isArray(originalDetail[key]) ? originalDetail[key].map(value => value) : originalDetail[key]
+  })
+  return copyDetail
+}
+var _default = exports.default = cloneDescriptorDetail

package/dist/helpers/descriptors/compareDescriptor.d.ts

@@ -1,12 +1,14 @@
-import 'core-js/stable';
-import { descriptor } from './samples/descriptor';
-/**
- * Check if two descriptors are the same or similar in that they have similar keys and the associated types are the same.
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptor} descriptor1
- * @param {module:objectDescriptors~descriptor} descriptor2
- * @returns {boolean}
- */
-declare const compareDescriptor: (descriptor1: descriptor, descriptor2: descriptor) => boolean;
-export default compareDescriptor;
+import 'core-js/stable';
+import { descriptor } from './samples/descriptor';
+/**
+ * Check if two descriptors are the same or similar, in that the smaller one's keys are all present in the larger
+ * one and their types line up - used to detect when a newly-described value actually matches a descriptor already
+ * in the map, so it can be pointed at instead of creating a duplicate.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptor} descriptor1 - The first descriptor to compare.
+ * @param {module:objectDescriptors~descriptor} descriptor2 - The second descriptor to compare.
+ * @returns {boolean} True if the descriptors describe a compatible shape.
+ */
+declare const compareDescriptor: (descriptor1: descriptor, descriptor2: descriptor) => boolean;
+export default compareDescriptor;
 //# sourceMappingURL=compareDescriptor.d.ts.map

package/dist/helpers/descriptors/compareDescriptor.js

@@ -1,31 +1,33 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/modules/es.array.includes.js')
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.every.js')
-require('core-js/modules/esnext.iterator.find.js')
-require('core-js/modules/esnext.iterator.some.js')
-require('core-js/stable')
-/**
- * Check if two descriptors are the same or similar in that they have similar keys and the associated types are the same.
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptor} descriptor1
- * @param {module:objectDescriptors~descriptor} descriptor2
- * @returns {boolean}
- */
-const compareDescriptor = (descriptor1, descriptor2) => {
-  if (descriptor1.isArray !== descriptor2.isArray) {
-    return false
-  }
-  if (descriptor1.length === 0 || descriptor2.length === 0) {
-    return descriptor1.length === descriptor2.length
-  }
-  const smallerDescriptor = descriptor1.length <= descriptor2.length ? descriptor1 : descriptor2
-  const largerDescriptor = descriptor2.length >= descriptor1.length ? descriptor2 : descriptor1
-  return smallerDescriptor.keys.every(key => largerDescriptor.keys.includes(key)) ? smallerDescriptor.details.every(detail => detail.type.some(type => largerDescriptor.details.find(foundDetail => foundDetail.key === detail.key).type.includes(type))) : false
-}
-var _default = exports.default = compareDescriptor
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/modules/es.array.includes.js')
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.every.js')
+require('core-js/modules/esnext.iterator.find.js')
+require('core-js/modules/esnext.iterator.some.js')
+require('core-js/stable')
+/**
+ * Check if two descriptors are the same or similar, in that the smaller one's keys are all present in the larger
+ * one and their types line up - used to detect when a newly-described value actually matches a descriptor already
+ * in the map, so it can be pointed at instead of creating a duplicate.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptor} descriptor1 - The first descriptor to compare.
+ * @param {module:objectDescriptors~descriptor} descriptor2 - The second descriptor to compare.
+ * @returns {boolean} True if the descriptors describe a compatible shape.
+ */
+const compareDescriptor = (descriptor1, descriptor2) => {
+  if (descriptor1.isArray !== descriptor2.isArray) {
+    return false
+  }
+  if (descriptor1.length === 0 || descriptor2.length === 0) {
+    return descriptor1.length === descriptor2.length
+  }
+  const smallerDescriptor = descriptor1.length <= descriptor2.length ? descriptor1 : descriptor2
+  const largerDescriptor = descriptor2.length >= descriptor1.length ? descriptor2 : descriptor1
+  return smallerDescriptor.keys.every(key => largerDescriptor.keys.includes(key)) ? smallerDescriptor.details.every(detail => detail.type.some(type => largerDescriptor.details.find(foundDetail => foundDetail.key === detail.key).type.includes(type))) : false
+}
+var _default = exports.default = compareDescriptor

package/dist/helpers/descriptors/describeObject.d.ts

@@ -1,14 +1,16 @@
-import 'core-js/stable';
-import { descriptor } from './samples/descriptor';
-export type describeableObject = Array<any> | {
-    [k: number | string]: any;
-};
-/**
- * Trace an object and return the descriptor which defines the object's structure and attributes.
- * @memberOf module:objectDescriptors
- * @param {Object} object
- * @returns {module:objectDescriptors~descriptor}
- */
-declare const describeObject: (object: describeableObject) => descriptor;
-export default describeObject;
+import 'core-js/stable';
+import { descriptor } from './samples/descriptor';
+export type describeableObject = Array<any> | {
+    [k: number | string]: any;
+};
+/**
+ * Trace a single object or array (not its nested objects/arrays - see
+ * {@link module:objectDescriptors.describeObjectMap} for that) and return the descriptor which defines its own
+ * structure and attributes.
+ * @memberOf module:objectDescriptors
+ * @param {Object|Array} object - The object or array to describe.
+ * @returns {module:objectDescriptors~descriptor}
+ */
+declare const describeObject: (object: describeableObject) => descriptor;
+export default describeObject;
 //# sourceMappingURL=describeObject.d.ts.map

package/dist/helpers/descriptors/describeObject.js

@@ -1,51 +1,53 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-var _assignDescriptorDetail = _interopRequireDefault(require('./assignDescriptorDetail'))
-var _describeObjectDetail = _interopRequireDefault(require('./describeObjectDetail'))
-var _objectKeys = _interopRequireDefault(require('../objects/objectKeys'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Trace an object and return the descriptor which defines the object's structure and attributes.
- * @memberOf module:objectDescriptors
- * @param {Object} object
- * @returns {module:objectDescriptors~descriptor}
- */
-const describeObject = object => {
-  const descriptor = {
-    index: 0,
-    details: [],
-    length: 0,
-    keys: [],
-    references: [],
-    isArray: false,
-    complete: false
-  }
-  const keys = (0, _objectKeys.default)(object)
-  for (let i = 0; i < keys.length; ++i) {
-    const key = keys[i]
-    // @ts-ignore
-    const newDetail = (0, _describeObjectDetail.default)(object[key], key, descriptor.length++)
-    if (typeof key === 'number' && descriptor.details.length) {
-      descriptor.details[0] = (0, _assignDescriptorDetail.default)(descriptor.details[0], newDetail)
-      descriptor.keys = [0]
-      if (newDetail.isReference) {
-        descriptor.references = [0]
-      }
-      continue
-    }
-    descriptor.details.push(newDetail)
-    descriptor.keys.push(newDetail.key)
-    if (newDetail.isReference) {
-      descriptor.references.push(newDetail.index)
-    }
-  }
-  descriptor.isArray = Array.isArray(object)
-  descriptor.complete = !descriptor.references.length
-  return descriptor
-}
-var _default = exports.default = describeObject
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+var _assignDescriptorDetail = _interopRequireDefault(require('./assignDescriptorDetail'))
+var _describeObjectDetail = _interopRequireDefault(require('./describeObjectDetail'))
+var _objectKeys = _interopRequireDefault(require('../objects/objectKeys'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Trace a single object or array (not its nested objects/arrays - see
+ * {@link module:objectDescriptors.describeObjectMap} for that) and return the descriptor which defines its own
+ * structure and attributes.
+ * @memberOf module:objectDescriptors
+ * @param {Object|Array} object - The object or array to describe.
+ * @returns {module:objectDescriptors~descriptor}
+ */
+const describeObject = object => {
+  const descriptor = {
+    index: 0,
+    details: [],
+    length: 0,
+    keys: [],
+    references: [],
+    isArray: false,
+    complete: false
+  }
+  const keys = (0, _objectKeys.default)(object)
+  for (let i = 0; i < keys.length; ++i) {
+    const key = keys[i]
+    // @ts-ignore
+    const newDetail = (0, _describeObjectDetail.default)(object[key], key, descriptor.length++)
+    if (typeof key === 'number' && descriptor.details.length) {
+      descriptor.details[0] = (0, _assignDescriptorDetail.default)(descriptor.details[0], newDetail)
+      descriptor.keys = [0]
+      if (newDetail.isReference) {
+        descriptor.references = [0]
+      }
+      continue
+    }
+    descriptor.details.push(newDetail)
+    descriptor.keys.push(newDetail.key)
+    if (newDetail.isReference) {
+      descriptor.references.push(newDetail.index)
+    }
+  }
+  descriptor.isArray = Array.isArray(object)
+  descriptor.complete = !descriptor.references.length
+  return descriptor
+}
+var _default = exports.default = describeObject