si-funciona 2.6.1 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (171) hide show
  1. package/README.md +48 -19
  2. package/browser/siFunciona.js +80 -77
  3. package/browser/siFunciona.min.js +1 -1
  4. package/dist/helpers/arrays/BasicQueue.d.ts +64 -64
  5. package/dist/helpers/arrays/BasicQueue.js +61 -61
  6. package/dist/helpers/arrays/addUniqueToArray.d.ts +9 -9
  7. package/dist/helpers/arrays/addUniqueToArray.js +16 -16
  8. package/dist/helpers/arrays/buildArray.d.ts +10 -10
  9. package/dist/helpers/arrays/buildArray.js +25 -25
  10. package/dist/helpers/arrays/buildArrayOfReferences.d.ts +10 -10
  11. package/dist/helpers/arrays/buildArrayOfReferences.js +22 -22
  12. package/dist/helpers/arrays/compareArrays.d.ts +96 -96
  13. package/dist/helpers/arrays/compareArrays.js +96 -96
  14. package/dist/helpers/arrays/mergeArrays.d.ts +8 -8
  15. package/dist/helpers/arrays/mergeArrays.js +21 -21
  16. package/dist/helpers/arrays/uniqueArray.d.ts +8 -8
  17. package/dist/helpers/arrays/uniqueArray.js +16 -16
  18. package/dist/helpers/arrays.d.ts +27 -27
  19. package/dist/helpers/arrays.js +74 -74
  20. package/dist/helpers/descriptors/assignDescriptor.d.ts +13 -13
  21. package/dist/helpers/descriptors/assignDescriptor.js +57 -57
  22. package/dist/helpers/descriptors/assignDescriptorDetail.d.ts +13 -13
  23. package/dist/helpers/descriptors/assignDescriptorDetail.js +36 -36
  24. package/dist/helpers/descriptors/checkClearValues.d.ts +11 -11
  25. package/dist/helpers/descriptors/checkClearValues.js +20 -20
  26. package/dist/helpers/descriptors/checkDescriptorComplete.d.ts +10 -10
  27. package/dist/helpers/descriptors/checkDescriptorComplete.js +19 -19
  28. package/dist/helpers/descriptors/cloneDescriptor.d.ts +9 -9
  29. package/dist/helpers/descriptors/cloneDescriptor.js +35 -35
  30. package/dist/helpers/descriptors/cloneDescriptorDetail.d.ts +9 -9
  31. package/dist/helpers/descriptors/cloneDescriptorDetail.js +26 -26
  32. package/dist/helpers/descriptors/compareDescriptor.d.ts +12 -12
  33. package/dist/helpers/descriptors/compareDescriptor.js +32 -32
  34. package/dist/helpers/descriptors/describeObject.d.ts +14 -14
  35. package/dist/helpers/descriptors/describeObject.js +52 -52
  36. package/dist/helpers/descriptors/describeObjectDetail.d.ts +13 -13
  37. package/dist/helpers/descriptors/describeObjectDetail.js +37 -37
  38. package/dist/helpers/descriptors/describeObjectMap.d.ts +35 -35
  39. package/dist/helpers/descriptors/describeObjectMap.js +107 -107
  40. package/dist/helpers/descriptors/nextReference.d.ts +12 -12
  41. package/dist/helpers/descriptors/nextReference.js +30 -30
  42. package/dist/helpers/descriptors/sameDescriptor.d.ts +12 -12
  43. package/dist/helpers/descriptors/sameDescriptor.js +21 -21
  44. package/dist/helpers/descriptors/samples/descriptor.d.ts +34 -34
  45. package/dist/helpers/descriptors/samples/descriptor.js +22 -22
  46. package/dist/helpers/descriptors/samples/descriptorDetail.d.ts +42 -42
  47. package/dist/helpers/descriptors/samples/descriptorDetail.js +24 -24
  48. package/dist/helpers/descriptors/samples/descriptorMap.d.ts +16 -16
  49. package/dist/helpers/descriptors/samples/descriptorMap.js +14 -14
  50. package/dist/helpers/descriptors/samples/mappedDescriptorMap.d.ts +10 -10
  51. package/dist/helpers/descriptors/samples/mappedDescriptorMap.js +287 -287
  52. package/dist/helpers/descriptors.d.ts +56 -56
  53. package/dist/helpers/descriptors.js +129 -129
  54. package/dist/helpers/functions/callWithParams.d.ts +10 -10
  55. package/dist/helpers/functions/callWithParams.js +16 -16
  56. package/dist/helpers/functions/curry.d.ts +10 -10
  57. package/dist/helpers/functions/curry.js +16 -16
  58. package/dist/helpers/functions/delay.d.ts +20 -20
  59. package/dist/helpers/functions/delay.js +31 -31
  60. package/dist/helpers/functions/makeBasicQueue.d.ts +9 -9
  61. package/dist/helpers/functions/makeBasicQueue.js +18 -18
  62. package/dist/helpers/functions/onBodyLoad.d.ts +9 -9
  63. package/dist/helpers/functions/onBodyLoad.js +75 -75
  64. package/dist/helpers/functions/pipe.d.ts +9 -9
  65. package/dist/helpers/functions/pipe.js +17 -17
  66. package/dist/helpers/functions/preloadParams.d.ts +19 -19
  67. package/dist/helpers/functions/preloadParams.js +20 -20
  68. package/dist/helpers/functions/queueManager.d.ts +48 -48
  69. package/dist/helpers/functions/queueManager.js +123 -123
  70. package/dist/helpers/functions/queueTimeout.d.ts +20 -20
  71. package/dist/helpers/functions/queueTimeout.js +22 -22
  72. package/dist/helpers/functions/relevancyFilter.d.ts +34 -34
  73. package/dist/helpers/functions/relevancyFilter.js +33 -33
  74. package/dist/helpers/functions/trace.d.ts +13 -13
  75. package/dist/helpers/functions/trace.js +24 -24
  76. package/dist/helpers/functions.d.ts +40 -40
  77. package/dist/helpers/functions.js +105 -105
  78. package/dist/helpers/numbers/absoluteMax.d.ts +9 -9
  79. package/dist/helpers/numbers/absoluteMax.js +15 -15
  80. package/dist/helpers/numbers/absoluteMin.d.ts +9 -9
  81. package/dist/helpers/numbers/absoluteMin.js +15 -15
  82. package/dist/helpers/numbers/compare.d.ts +12 -12
  83. package/dist/helpers/numbers/compare.js +18 -18
  84. package/dist/helpers/numbers/greatestCommonDivisor.d.ts +9 -9
  85. package/dist/helpers/numbers/greatestCommonDivisor.js +15 -15
  86. package/dist/helpers/numbers/leastCommonMultiple.d.ts +9 -9
  87. package/dist/helpers/numbers/leastCommonMultiple.js +17 -17
  88. package/dist/helpers/numbers/lowestCommonDenominator.d.ts +9 -9
  89. package/dist/helpers/numbers/lowestCommonDenominator.js +19 -19
  90. package/dist/helpers/numbers/randomInteger.d.ts +18 -12
  91. package/dist/helpers/numbers/randomInteger.js +24 -18
  92. package/dist/helpers/numbers/randomNumber.d.ts +13 -12
  93. package/dist/helpers/numbers/randomNumber.js +19 -18
  94. package/dist/helpers/numbers/simplestRatio.d.ts +8 -8
  95. package/dist/helpers/numbers/simplestRatio.js +28 -28
  96. package/dist/helpers/numbers.d.ts +30 -30
  97. package/dist/helpers/numbers.js +89 -89
  98. package/dist/helpers/objects/cloneObject.d.ts +2 -4
  99. package/dist/helpers/objects/cloneObject.js +2 -4
  100. package/dist/helpers/objects/dotGet.d.ts +11 -11
  101. package/dist/helpers/objects/dotGet.js +59 -59
  102. package/dist/helpers/objects/dotNotate.d.ts +27 -27
  103. package/dist/helpers/objects/dotNotate.js +79 -79
  104. package/dist/helpers/objects/dotSet.d.ts +11 -11
  105. package/dist/helpers/objects/dotSet.js +53 -53
  106. package/dist/helpers/objects/dotUnset.d.ts +10 -10
  107. package/dist/helpers/objects/dotUnset.js +52 -52
  108. package/dist/helpers/objects/emptyObject.d.ts +8 -8
  109. package/dist/helpers/objects/emptyObject.js +17 -17
  110. package/dist/helpers/objects/filterObject.d.ts +26 -26
  111. package/dist/helpers/objects/filterObject.js +33 -33
  112. package/dist/helpers/objects/isCloneable.d.ts +8 -8
  113. package/dist/helpers/objects/isCloneable.js +16 -16
  114. package/dist/helpers/objects/isEqual.d.ts +16 -16
  115. package/dist/helpers/objects/isEqual.js +100 -100
  116. package/dist/helpers/objects/isInstanceObject.d.ts +8 -8
  117. package/dist/helpers/objects/isInstanceObject.js +26 -26
  118. package/dist/helpers/objects/isObject.d.ts +8 -8
  119. package/dist/helpers/objects/isObject.js +14 -14
  120. package/dist/helpers/objects/mapObject.d.ts +25 -25
  121. package/dist/helpers/objects/mapObject.js +25 -25
  122. package/dist/helpers/objects/mergeObjects.d.ts +12 -12
  123. package/dist/helpers/objects/mergeObjects.js +19 -19
  124. package/dist/helpers/objects/mergeObjectsBase.d.ts +9 -6
  125. package/dist/helpers/objects/mergeObjectsBase.js +59 -61
  126. package/dist/helpers/objects/mergeObjectsBase.min.js +1 -1
  127. package/dist/helpers/objects/mergeObjectsMutable.d.ts +12 -12
  128. package/dist/helpers/objects/mergeObjectsMutable.js +17 -17
  129. package/dist/helpers/objects/objectKeys.d.ts +13 -13
  130. package/dist/helpers/objects/objectKeys.js +39 -39
  131. package/dist/helpers/objects/objectValues.d.ts +13 -13
  132. package/dist/helpers/objects/objectValues.js +20 -20
  133. package/dist/helpers/objects/reduceObject.d.ts +30 -30
  134. package/dist/helpers/objects/reduceObject.js +25 -25
  135. package/dist/helpers/objects/setAndReturnValue.d.ts +13 -13
  136. package/dist/helpers/objects/setAndReturnValue.js +19 -19
  137. package/dist/helpers/objects/setValue.d.ts +14 -14
  138. package/dist/helpers/objects/setValue.js +21 -21
  139. package/dist/helpers/objects.d.ts +1 -1
  140. package/dist/helpers/objects.js +177 -177
  141. package/dist/helpers/strings/camelCase.d.ts +8 -8
  142. package/dist/helpers/strings/camelCase.js +19 -19
  143. package/dist/helpers/strings/kabobCase.d.ts +8 -8
  144. package/dist/helpers/strings/kabobCase.js +18 -18
  145. package/dist/helpers/strings/makeFilepath.d.ts +9 -9
  146. package/dist/helpers/strings/makeFilepath.js +49 -49
  147. package/dist/helpers/strings/makeRelativePath.d.ts +9 -9
  148. package/dist/helpers/strings/makeRelativePath.js +43 -43
  149. package/dist/helpers/strings/regexEscape.d.ts +8 -8
  150. package/dist/helpers/strings/regexEscape.js +15 -15
  151. package/dist/helpers/strings/snakeCase.d.ts +8 -8
  152. package/dist/helpers/strings/snakeCase.js +18 -18
  153. package/dist/helpers/strings/strAfter.d.ts +9 -9
  154. package/dist/helpers/strings/strAfter.js +18 -18
  155. package/dist/helpers/strings/strAfterLast.d.ts +9 -9
  156. package/dist/helpers/strings/strAfterLast.js +18 -18
  157. package/dist/helpers/strings/strBefore.d.ts +9 -9
  158. package/dist/helpers/strings/strBefore.js +18 -18
  159. package/dist/helpers/strings/strBeforeLast.d.ts +9 -9
  160. package/dist/helpers/strings/strBeforeLast.js +18 -18
  161. package/dist/helpers/strings/titleCase.d.ts +8 -8
  162. package/dist/helpers/strings/titleCase.js +19 -19
  163. package/dist/helpers/strings/ucFirst.d.ts +8 -8
  164. package/dist/helpers/strings/ucFirst.js +14 -14
  165. package/dist/helpers/strings/words.d.ts +9 -9
  166. package/dist/helpers/strings/words.js +15 -15
  167. package/dist/helpers/strings.d.ts +38 -38
  168. package/dist/helpers/strings.js +121 -121
  169. package/dist/main.d.ts +15 -15
  170. package/dist/main.js +103 -103
  171. package/package.json +4 -4
@@ -1,13 +1,13 @@
1
- import { descriptor } from './samples/descriptor';
2
- /**
3
- * Check if two descriptors describe the exact same underlying values (not just compatible types, like
4
- * {@link module:objectDescriptors.compareDescriptor} does) - used to detect genuine circular references, where a
5
- * nested value's descriptor turns out to be identical to one of its own ancestors.
6
- * @memberOf module:objectDescriptors
7
- * @param {module:objectDescriptors~descriptor} descriptor1 - The first descriptor to compare.
8
- * @param {module:objectDescriptors~descriptor} descriptor2 - The second descriptor to compare.
9
- * @returns {boolean} True if every detail's values match at the same position.
10
- */
11
- declare const sameDescriptor: (descriptor1: descriptor, descriptor2: descriptor) => boolean;
12
- export default sameDescriptor;
1
+ import { descriptor } from './samples/descriptor';
2
+ /**
3
+ * Check if two descriptors describe the exact same underlying values (not just compatible types, like
4
+ * {@link module:objectDescriptors.compareDescriptor} does) - used to detect genuine circular references, where a
5
+ * nested value's descriptor turns out to be identical to one of its own ancestors.
6
+ * @memberOf module:objectDescriptors
7
+ * @param {module:objectDescriptors~descriptor} descriptor1 - The first descriptor to compare.
8
+ * @param {module:objectDescriptors~descriptor} descriptor2 - The second descriptor to compare.
9
+ * @returns {boolean} True if every detail's values match at the same position.
10
+ */
11
+ declare const sameDescriptor: (descriptor1: descriptor, descriptor2: descriptor) => boolean;
12
+ export default sameDescriptor;
13
13
  //# sourceMappingURL=sameDescriptor.d.ts.map
@@ -1,21 +1,21 @@
1
- 'use strict'
2
-
3
- Object.defineProperty(exports, '__esModule', {
4
- value: true
5
- })
6
- exports.default = void 0
7
- require('core-js/modules/es.array.includes.js')
8
- require('core-js/modules/esnext.iterator.constructor.js')
9
- require('core-js/modules/esnext.iterator.every.js')
10
- require('core-js/modules/esnext.iterator.some.js')
11
- /**
12
- * Check if two descriptors describe the exact same underlying values (not just compatible types, like
13
- * {@link module:objectDescriptors.compareDescriptor} does) - used to detect genuine circular references, where a
14
- * nested value's descriptor turns out to be identical to one of its own ancestors.
15
- * @memberOf module:objectDescriptors
16
- * @param {module:objectDescriptors~descriptor} descriptor1 - The first descriptor to compare.
17
- * @param {module:objectDescriptors~descriptor} descriptor2 - The second descriptor to compare.
18
- * @returns {boolean} True if every detail's values match at the same position.
19
- */
20
- const sameDescriptor = (descriptor1, descriptor2) => descriptor1.details.every((detail, index) => detail.value.some(dVal => descriptor2.details[index].value.includes(dVal)))
21
- const _default = exports.default = sameDescriptor
1
+ 'use strict'
2
+
3
+ Object.defineProperty(exports, '__esModule', {
4
+ value: true
5
+ })
6
+ exports.default = void 0
7
+ require('core-js/modules/es.array.includes.js')
8
+ require('core-js/modules/esnext.iterator.constructor.js')
9
+ require('core-js/modules/esnext.iterator.every.js')
10
+ require('core-js/modules/esnext.iterator.some.js')
11
+ /**
12
+ * Check if two descriptors describe the exact same underlying values (not just compatible types, like
13
+ * {@link module:objectDescriptors.compareDescriptor} does) - used to detect genuine circular references, where a
14
+ * nested value's descriptor turns out to be identical to one of its own ancestors.
15
+ * @memberOf module:objectDescriptors
16
+ * @param {module:objectDescriptors~descriptor} descriptor1 - The first descriptor to compare.
17
+ * @param {module:objectDescriptors~descriptor} descriptor2 - The second descriptor to compare.
18
+ * @returns {boolean} True if every detail's values match at the same position.
19
+ */
20
+ const sameDescriptor = (descriptor1, descriptor2) => descriptor1.details.every((detail, index) => detail.value.some(dVal => descriptor2.details[index].value.includes(dVal)))
21
+ const _default = exports.default = sameDescriptor
@@ -1,35 +1,35 @@
1
- import { descriptorDetail } from './descriptorDetail';
2
- /**
3
- * A flat, serializable description of one object or array's shape - see the {@link module:objectDescriptors} module
4
- * description for the concept this represents. One `descriptor` covers a single level of nesting; a nested
5
- * object/array's own shape is a separate `descriptor` elsewhere in the same {@link module:objectDescriptors~descriptorMap},
6
- * pointed to via the relevant `descriptorDetail`'s `arrayReference`/`objectReference`.
7
- * @typedef {Object} module:objectDescriptors~descriptor
8
- * @memberOf module:objectDescriptors
9
- * @property {number} index - This descriptor's own position in the descriptorMap it belongs to.
10
- * @property {Array.<module:objectDescriptors~descriptorDetail>} details - One entry per property/element of the
11
- * described object or array.
12
- * @property {number} length - The number of properties/elements described (i.e. `details.length`).
13
- * @property {Array.<string|number>} keys - The property names (or array indexes) described, in the same order as `details`.
14
- * @property {Array.<number>} references - The `index` values (from `details`) of properties whose own value is
15
- * itself an object/array, and so has a separate descriptor elsewhere in the map.
16
- * @property {boolean} isArray - Whether the described value was an array (true) or a plain object (false).
17
- * @property {boolean} complete - Whether every referenced nested descriptor has actually been resolved yet - false
18
- * while still being built, true once nothing referenced is left pending.
19
- */
20
- export type descriptor = {
21
- index: number;
22
- details: Array<descriptorDetail>;
23
- length: number;
24
- keys: Array<number | string>;
25
- references: Array<number>;
26
- isArray: boolean;
27
- complete: boolean;
28
- };
29
- /**
30
- * @type {module:objectDescriptors~descriptor}
31
- * @memberOf module:objectDescriptors
32
- */
33
- declare const descriptorSample: descriptor;
34
- export default descriptorSample;
1
+ import { descriptorDetail } from './descriptorDetail';
2
+ /**
3
+ * A flat, serializable description of one object or array's shape - see the {@link module:objectDescriptors} module
4
+ * description for the concept this represents. One `descriptor` covers a single level of nesting; a nested
5
+ * object/array's own shape is a separate `descriptor` elsewhere in the same {@link module:objectDescriptors~descriptorMap},
6
+ * pointed to via the relevant `descriptorDetail`'s `arrayReference`/`objectReference`.
7
+ * @typedef {Object} module:objectDescriptors~descriptor
8
+ * @memberOf module:objectDescriptors
9
+ * @property {number} index - This descriptor's own position in the descriptorMap it belongs to.
10
+ * @property {Array.<module:objectDescriptors~descriptorDetail>} details - One entry per property/element of the
11
+ * described object or array.
12
+ * @property {number} length - The number of properties/elements described (i.e. `details.length`).
13
+ * @property {Array.<string|number>} keys - The property names (or array indexes) described, in the same order as `details`.
14
+ * @property {Array.<number>} references - The `index` values (from `details`) of properties whose own value is
15
+ * itself an object/array, and so has a separate descriptor elsewhere in the map.
16
+ * @property {boolean} isArray - Whether the described value was an array (true) or a plain object (false).
17
+ * @property {boolean} complete - Whether every referenced nested descriptor has actually been resolved yet - false
18
+ * while still being built, true once nothing referenced is left pending.
19
+ */
20
+ export type descriptor = {
21
+ index: number;
22
+ details: Array<descriptorDetail>;
23
+ length: number;
24
+ keys: Array<number | string>;
25
+ references: Array<number>;
26
+ isArray: boolean;
27
+ complete: boolean;
28
+ };
29
+ /**
30
+ * @type {module:objectDescriptors~descriptor}
31
+ * @memberOf module:objectDescriptors
32
+ */
33
+ declare const descriptorSample: descriptor;
34
+ export default descriptorSample;
35
35
  //# sourceMappingURL=descriptor.d.ts.map
@@ -1,22 +1,22 @@
1
- 'use strict'
2
-
3
- Object.defineProperty(exports, '__esModule', {
4
- value: true
5
- })
6
- exports.default = void 0
7
- const _descriptorDetail = _interopRequireDefault(require('./descriptorDetail'))
8
- function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
9
- /**
10
- * @type {module:objectDescriptors~descriptor}
11
- * @memberOf module:objectDescriptors
12
- */
13
- const descriptorSample = {
14
- index: 0,
15
- details: [_descriptorDetail.default],
16
- length: 1,
17
- keys: [_descriptorDetail.default.key],
18
- references: [],
19
- isArray: false,
20
- complete: true
21
- }
22
- const _default = exports.default = descriptorSample
1
+ 'use strict'
2
+
3
+ Object.defineProperty(exports, '__esModule', {
4
+ value: true
5
+ })
6
+ exports.default = void 0
7
+ const _descriptorDetail = _interopRequireDefault(require('./descriptorDetail'))
8
+ function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
9
+ /**
10
+ * @type {module:objectDescriptors~descriptor}
11
+ * @memberOf module:objectDescriptors
12
+ */
13
+ const descriptorSample = {
14
+ index: 0,
15
+ details: [_descriptorDetail.default],
16
+ length: 1,
17
+ keys: [_descriptorDetail.default.key],
18
+ references: [],
19
+ isArray: false,
20
+ complete: true
21
+ }
22
+ const _default = exports.default = descriptorSample
@@ -1,43 +1,43 @@
1
- /**
2
- * A description of one single property/element within a {@link module:objectDescriptors~descriptor}.
3
- * @typedef {Object} module:objectDescriptors~descriptorDetail
4
- * @memberOf module:objectDescriptors
5
- * @property {number} index - This detail's own position within its parent descriptor's `details` array.
6
- * @property {string|number} key - The property name (or array index) this detail describes.
7
- * @property {Array.<string>} type - The `typeof` result(s) seen for this property's value - more than one entry
8
- * means the same key held different types across multiple objects that were merged/compared into this descriptor.
9
- * @property {Array} value - The actual value(s) seen for this property, kept only until the descriptor is marked
10
- * `complete` (see {@link module:objectDescriptors.checkClearValues}), then cleared to save memory.
11
- * @property {boolean} nullable - Whether this property's value has been seen as `null`.
12
- * @property {boolean} optional - Whether this property is missing on some, but not all, of the compared objects.
13
- * @property {boolean} circular - Whether following this property's own nested value would lead back to an ancestor
14
- * already being described (a genuine circular reference), rather than a normal, resolvable nested object/array.
15
- * @property {boolean} isReference - Whether this property's value is itself an object/array, and so has its own
16
- * separate descriptor elsewhere in the descriptorMap (pointed to by `arrayReference`/`objectReference` below).
17
- * @property {boolean} isInstance - Whether this property's value is an instance of a custom class (as opposed to a
18
- * plain Object or Array literal) - such values are treated as opaque and not traced further.
19
- * @property {null|number} arrayReference - If this property's value is an array, the index (within the
20
- * descriptorMap) of that array's own descriptor; `null` otherwise.
21
- * @property {null|number} objectReference - If this property's value is a plain object, the index (within the
22
- * descriptorMap) of that object's own descriptor; `null` otherwise.
23
- */
24
- export type descriptorDetail = {
25
- index: number;
26
- key: number | string;
27
- type: Array<string>;
28
- value: Array<any>;
29
- nullable: boolean;
30
- optional: boolean;
31
- circular: boolean;
32
- isReference: boolean;
33
- isInstance: boolean;
34
- arrayReference: number | null;
35
- objectReference: number | null;
36
- };
37
- /**
38
- * @type {module:objectDescriptors~descriptorDetail}
39
- * @memberOf module:objectDescriptors
40
- */
41
- declare const descriptorDetailSample: descriptorDetail;
42
- export default descriptorDetailSample;
1
+ /**
2
+ * A description of one single property/element within a {@link module:objectDescriptors~descriptor}.
3
+ * @typedef {Object} module:objectDescriptors~descriptorDetail
4
+ * @memberOf module:objectDescriptors
5
+ * @property {number} index - This detail's own position within its parent descriptor's `details` array.
6
+ * @property {string|number} key - The property name (or array index) this detail describes.
7
+ * @property {Array.<string>} type - The `typeof` result(s) seen for this property's value - more than one entry
8
+ * means the same key held different types across multiple objects that were merged/compared into this descriptor.
9
+ * @property {Array} value - The actual value(s) seen for this property, kept only until the descriptor is marked
10
+ * `complete` (see {@link module:objectDescriptors.checkClearValues}), then cleared to save memory.
11
+ * @property {boolean} nullable - Whether this property's value has been seen as `null`.
12
+ * @property {boolean} optional - Whether this property is missing on some, but not all, of the compared objects.
13
+ * @property {boolean} circular - Whether following this property's own nested value would lead back to an ancestor
14
+ * already being described (a genuine circular reference), rather than a normal, resolvable nested object/array.
15
+ * @property {boolean} isReference - Whether this property's value is itself an object/array, and so has its own
16
+ * separate descriptor elsewhere in the descriptorMap (pointed to by `arrayReference`/`objectReference` below).
17
+ * @property {boolean} isInstance - Whether this property's value is an instance of a custom class (as opposed to a
18
+ * plain Object or Array literal) - such values are treated as opaque and not traced further.
19
+ * @property {null|number} arrayReference - If this property's value is an array, the index (within the
20
+ * descriptorMap) of that array's own descriptor; `null` otherwise.
21
+ * @property {null|number} objectReference - If this property's value is a plain object, the index (within the
22
+ * descriptorMap) of that object's own descriptor; `null` otherwise.
23
+ */
24
+ export type descriptorDetail = {
25
+ index: number;
26
+ key: number | string;
27
+ type: Array<string>;
28
+ value: Array<any>;
29
+ nullable: boolean;
30
+ optional: boolean;
31
+ circular: boolean;
32
+ isReference: boolean;
33
+ isInstance: boolean;
34
+ arrayReference: number | null;
35
+ objectReference: number | null;
36
+ };
37
+ /**
38
+ * @type {module:objectDescriptors~descriptorDetail}
39
+ * @memberOf module:objectDescriptors
40
+ */
41
+ declare const descriptorDetailSample: descriptorDetail;
42
+ export default descriptorDetailSample;
43
43
  //# sourceMappingURL=descriptorDetail.d.ts.map
@@ -1,24 +1,24 @@
1
- 'use strict'
2
-
3
- Object.defineProperty(exports, '__esModule', {
4
- value: true
5
- })
6
- exports.default = void 0
7
- /**
8
- * @type {module:objectDescriptors~descriptorDetail}
9
- * @memberOf module:objectDescriptors
10
- */
11
- const descriptorDetailSample = {
12
- index: 0,
13
- key: 'keyName',
14
- type: ['string'],
15
- value: [''],
16
- nullable: false,
17
- optional: false,
18
- circular: false,
19
- isReference: false,
20
- isInstance: false,
21
- arrayReference: null,
22
- objectReference: null
23
- }
24
- const _default = exports.default = descriptorDetailSample
1
+ 'use strict'
2
+
3
+ Object.defineProperty(exports, '__esModule', {
4
+ value: true
5
+ })
6
+ exports.default = void 0
7
+ /**
8
+ * @type {module:objectDescriptors~descriptorDetail}
9
+ * @memberOf module:objectDescriptors
10
+ */
11
+ const descriptorDetailSample = {
12
+ index: 0,
13
+ key: 'keyName',
14
+ type: ['string'],
15
+ value: [''],
16
+ nullable: false,
17
+ optional: false,
18
+ circular: false,
19
+ isReference: false,
20
+ isInstance: false,
21
+ arrayReference: null,
22
+ objectReference: null
23
+ }
24
+ const _default = exports.default = descriptorDetailSample
@@ -1,17 +1,17 @@
1
- import { descriptor } from './descriptor';
2
- /**
3
- * The full, flat result of describing an object graph: a list of every descriptor discovered, including nested
4
- * ones - the return type of {@link module:objectDescriptors.describeObjectMap}. Each descriptor's own `index`
5
- * matches its position in this array, which is how `arrayReference`/`objectReference` on a descriptorDetail point
6
- * back into it.
7
- * @typedef {Array.<module:objectDescriptors~descriptor>} module:objectDescriptors~descriptorMap
8
- * @memberOf module:objectDescriptors
9
- */
10
- export type descriptorMap = Array<descriptor>;
11
- /**
12
- * @type {module:objectDescriptors~descriptorMap}
13
- * @memberOf module:objectDescriptors
14
- */
15
- declare const descriptorMapSample: descriptorMap;
16
- export default descriptorMapSample;
1
+ import { descriptor } from './descriptor';
2
+ /**
3
+ * The full, flat result of describing an object graph: a list of every descriptor discovered, including nested
4
+ * ones - the return type of {@link module:objectDescriptors.describeObjectMap}. Each descriptor's own `index`
5
+ * matches its position in this array, which is how `arrayReference`/`objectReference` on a descriptorDetail point
6
+ * back into it.
7
+ * @typedef {Array.<module:objectDescriptors~descriptor>} module:objectDescriptors~descriptorMap
8
+ * @memberOf module:objectDescriptors
9
+ */
10
+ export type descriptorMap = Array<descriptor>;
11
+ /**
12
+ * @type {module:objectDescriptors~descriptorMap}
13
+ * @memberOf module:objectDescriptors
14
+ */
15
+ declare const descriptorMapSample: descriptorMap;
16
+ export default descriptorMapSample;
17
17
  //# sourceMappingURL=descriptorMap.d.ts.map
@@ -1,14 +1,14 @@
1
- 'use strict'
2
-
3
- Object.defineProperty(exports, '__esModule', {
4
- value: true
5
- })
6
- exports.default = void 0
7
- const _descriptor = _interopRequireDefault(require('./descriptor'))
8
- function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
9
- /**
10
- * @type {module:objectDescriptors~descriptorMap}
11
- * @memberOf module:objectDescriptors
12
- */
13
- const descriptorMapSample = [_descriptor.default]
14
- const _default = exports.default = descriptorMapSample
1
+ 'use strict'
2
+
3
+ Object.defineProperty(exports, '__esModule', {
4
+ value: true
5
+ })
6
+ exports.default = void 0
7
+ const _descriptor = _interopRequireDefault(require('./descriptor'))
8
+ function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
9
+ /**
10
+ * @type {module:objectDescriptors~descriptorMap}
11
+ * @memberOf module:objectDescriptors
12
+ */
13
+ const descriptorMapSample = [_descriptor.default]
14
+ const _default = exports.default = descriptorMapSample
@@ -1,11 +1,11 @@
1
- import { descriptorMap } from './descriptorMap';
2
- /**
3
- * A worked example descriptorMap, produced by describing a `descriptor` value itself (i.e. describing the shape of
4
- * a descriptor) - useful as a realistic fixture showing what a multi-entry descriptorMap with actual references
5
- * looks like, since `descriptorSample`/`descriptorMapSample` alone only demonstrate a trivial single-entry case.
6
- * @type {module:objectDescriptors~descriptorMap}
7
- * @memberOf module:objectDescriptors
8
- */
9
- declare const mappedDescriptorMap: descriptorMap;
10
- export default mappedDescriptorMap;
1
+ import { descriptorMap } from './descriptorMap';
2
+ /**
3
+ * A worked example descriptorMap, produced by describing a `descriptor` value itself (i.e. describing the shape of
4
+ * a descriptor) - useful as a realistic fixture showing what a multi-entry descriptorMap with actual references
5
+ * looks like, since `descriptorSample`/`descriptorMapSample` alone only demonstrate a trivial single-entry case.
6
+ * @type {module:objectDescriptors~descriptorMap}
7
+ * @memberOf module:objectDescriptors
8
+ */
9
+ declare const mappedDescriptorMap: descriptorMap;
10
+ export default mappedDescriptorMap;
11
11
  //# sourceMappingURL=mappedDescriptorMap.d.ts.map