@ls-stack/utils 3.65.0 → 3.67.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 (336) hide show
  1. package/dist/{arrayUtils.d.cts → arrayUtils.d.mts} +24 -23
  2. package/dist/arrayUtils.mjs +249 -0
  3. package/dist/assertions-qMxfVhSu.mjs +207 -0
  4. package/dist/{assertions.d.ts → assertions.d.mts} +4 -3
  5. package/dist/assertions.mjs +3 -0
  6. package/dist/asyncQueue.d.mts +497 -0
  7. package/dist/asyncQueue.mjs +757 -0
  8. package/dist/{awaitDebounce.d.cts → awaitDebounce.d.mts} +11 -6
  9. package/dist/awaitDebounce.mjs +54 -0
  10. package/dist/{cache.d.ts → cache.d.mts} +76 -68
  11. package/dist/cache.mjs +355 -0
  12. package/dist/castValues-DfICShCc.mjs +19 -0
  13. package/dist/{castValues.d.cts → castValues.d.mts} +3 -2
  14. package/dist/castValues.mjs +3 -0
  15. package/dist/{concurrentCalls.d.ts → concurrentCalls.d.mts} +74 -65
  16. package/dist/concurrentCalls.mjs +295 -0
  17. package/dist/consoleFmt.d.mts +55 -0
  18. package/dist/consoleFmt.mjs +63 -0
  19. package/dist/conversions-DTmwEMIu.mjs +12 -0
  20. package/dist/conversions.d.mts +4 -0
  21. package/dist/conversions.mjs +3 -0
  22. package/dist/createThrottleController.d.mts +18 -0
  23. package/dist/createThrottleController.mjs +40 -0
  24. package/dist/debounce.d.mts +47 -0
  25. package/dist/debounce.mjs +117 -0
  26. package/dist/dedent.d.mts +74 -0
  27. package/dist/dedent.mjs +80 -0
  28. package/dist/deepEqual-C7EZEixx.mjs +78 -0
  29. package/dist/{deepEqual.d.cts → deepEqual.d.mts} +3 -2
  30. package/dist/deepEqual.mjs +3 -0
  31. package/dist/{deepReplaceValues.d.cts → deepReplaceValues.d.mts} +4 -3
  32. package/dist/deepReplaceValues.mjs +61 -0
  33. package/dist/diffParser.d.mts +79 -0
  34. package/dist/diffParser.mjs +424 -0
  35. package/dist/enhancedMap.d.mts +21 -0
  36. package/dist/enhancedMap.mjs +69 -0
  37. package/dist/exhaustiveMatch.d.mts +10 -0
  38. package/dist/exhaustiveMatch.mjs +48 -0
  39. package/dist/{filterObjectOrArrayKeys.d.cts → filterObjectOrArrayKeys.d.mts} +15 -8
  40. package/dist/filterObjectOrArrayKeys.mjs +497 -0
  41. package/dist/{getAutoIncrementId.d.cts → getAutoIncrementId.d.mts} +9 -5
  42. package/dist/getAutoIncrementId.mjs +53 -0
  43. package/dist/{getCompositeKey.d.cts → getCompositeKey.d.mts} +3 -2
  44. package/dist/getCompositeKey.mjs +50 -0
  45. package/dist/{getValueStableKey.d.cts → getValueStableKey.d.mts} +5 -3
  46. package/dist/getValueStableKey.mjs +17 -0
  47. package/dist/{hash.d.cts → hash.d.mts} +3 -2
  48. package/dist/hash.mjs +28 -0
  49. package/dist/interpolate.d.mts +17 -0
  50. package/dist/interpolate.mjs +28 -0
  51. package/dist/{iteratorUtils.d.cts → iteratorUtils.d.mts} +5 -4
  52. package/dist/iteratorUtils.mjs +39 -0
  53. package/dist/keepPrevIfUnchanged.d.mts +12 -0
  54. package/dist/keepPrevIfUnchanged.mjs +9 -0
  55. package/dist/keyedMap.d.mts +76 -0
  56. package/dist/keyedMap.mjs +139 -0
  57. package/dist/keyedSet.d.mts +77 -0
  58. package/dist/keyedSet.mjs +129 -0
  59. package/dist/{levenshtein.d.cts → levenshtein.d.mts} +3 -2
  60. package/dist/levenshtein.mjs +121 -0
  61. package/dist/main.d.mts +4 -0
  62. package/dist/main.mjs +7 -0
  63. package/dist/matchPath.d.mts +50 -0
  64. package/dist/matchPath.mjs +81 -0
  65. package/dist/mathUtils-BDP1lM_z.mjs +81 -0
  66. package/dist/{mathUtils.d.cts → mathUtils.d.mts} +3 -2
  67. package/dist/mathUtils.mjs +3 -0
  68. package/dist/{mutationUtils.d.cts → mutationUtils.d.mts} +6 -5
  69. package/dist/mutationUtils.mjs +44 -0
  70. package/dist/{objUtils.d.ts → objUtils.d.mts} +8 -6
  71. package/dist/objUtils.mjs +115 -0
  72. package/dist/parallelAsyncCalls.d.mts +83 -0
  73. package/dist/parallelAsyncCalls.mjs +121 -0
  74. package/dist/partialEqual.d.mts +139 -0
  75. package/dist/partialEqual.mjs +1055 -0
  76. package/dist/promiseUtils.d.mts +9 -0
  77. package/dist/promiseUtils.mjs +17 -0
  78. package/dist/regexUtils.d.mts +18 -0
  79. package/dist/regexUtils.mjs +34 -0
  80. package/dist/{retryOnError.d.cts → retryOnError.d.mts} +38 -37
  81. package/dist/retryOnError.mjs +91 -0
  82. package/dist/{runShellCmd.d.ts → runShellCmd.d.mts} +24 -15
  83. package/dist/runShellCmd.mjs +151 -0
  84. package/dist/{safeJson.d.cts → safeJson.d.mts} +3 -2
  85. package/dist/safeJson.mjs +30 -0
  86. package/dist/{saferTyping.d.cts → saferTyping.d.mts} +4 -3
  87. package/dist/saferTyping.mjs +45 -0
  88. package/dist/serializeXML.d.mts +23 -0
  89. package/dist/serializeXML.mjs +74 -0
  90. package/dist/{shallowEqual.d.cts → shallowEqual.d.mts} +3 -2
  91. package/dist/shallowEqual.mjs +54 -0
  92. package/dist/sleep.d.mts +4 -0
  93. package/dist/sleep.mjs +7 -0
  94. package/dist/stringUtils-DjhWOiYn.mjs +113 -0
  95. package/dist/{stringUtils.d.cts → stringUtils.d.mts} +3 -2
  96. package/dist/stringUtils.mjs +3 -0
  97. package/dist/{testUtils.d.ts → testUtils.d.mts} +83 -52
  98. package/dist/testUtils.mjs +310 -0
  99. package/dist/{throttle.d.ts → throttle.d.mts} +18 -17
  100. package/dist/throttle.mjs +102 -0
  101. package/dist/time-sr2lhQRw.mjs +67 -0
  102. package/dist/{time.d.ts → time.d.mts} +8 -7
  103. package/dist/time.mjs +3 -0
  104. package/dist/{timers.d.cts → timers.d.mts} +22 -13
  105. package/dist/timers.mjs +220 -0
  106. package/dist/{tsResult.d.cts → tsResult.d.mts} +52 -48
  107. package/dist/tsResult.mjs +142 -0
  108. package/dist/typeGuards-B1mzA-Rz.mjs +128 -0
  109. package/dist/{typeGuards.d.cts → typeGuards.d.mts} +3 -2
  110. package/dist/typeGuards.mjs +3 -0
  111. package/dist/{typeUtils.d.ts → typeUtils.d.mts} +13 -34
  112. package/dist/typeUtils.mjs +1 -0
  113. package/dist/{typedStrings.d.cts → typedStrings.d.mts} +5 -4
  114. package/dist/typedStrings.mjs +131 -0
  115. package/dist/typingFnUtils-Bb8drgKF.mjs +101 -0
  116. package/dist/{typingFnUtils.d.cts → typingFnUtils.d.mts} +13 -22
  117. package/dist/typingFnUtils.mjs +3 -0
  118. package/dist/{typingTestUtils.d.cts → typingTestUtils.d.mts} +11 -15
  119. package/dist/typingTestUtils.mjs +80 -0
  120. package/dist/typingUtils.d.mts +20 -0
  121. package/dist/typingUtils.mjs +1 -0
  122. package/dist/yamlStringify.d.mts +17 -0
  123. package/dist/yamlStringify.mjs +189 -0
  124. package/package.json +65 -242
  125. package/dist/arrayUtils.cjs +0 -229
  126. package/dist/arrayUtils.d.ts +0 -171
  127. package/dist/arrayUtils.js +0 -42
  128. package/dist/assertions.cjs +0 -107
  129. package/dist/assertions.d.cts +0 -192
  130. package/dist/assertions.js +0 -25
  131. package/dist/asyncQueue.cjs +0 -672
  132. package/dist/asyncQueue.d.cts +0 -488
  133. package/dist/asyncQueue.d.ts +0 -488
  134. package/dist/asyncQueue.js +0 -631
  135. package/dist/awaitDebounce.cjs +0 -106
  136. package/dist/awaitDebounce.d.ts +0 -41
  137. package/dist/awaitDebounce.js +0 -28
  138. package/dist/cache.cjs +0 -367
  139. package/dist/cache.d.cts +0 -228
  140. package/dist/cache.js +0 -19
  141. package/dist/castValues.cjs +0 -50
  142. package/dist/castValues.d.ts +0 -4
  143. package/dist/castValues.js +0 -8
  144. package/dist/chunk-5DZT3Z5Z.js +0 -8
  145. package/dist/chunk-6FBIEPWU.js +0 -96
  146. package/dist/chunk-6FIBVC2P.js +0 -56
  147. package/dist/chunk-7CQPOM5I.js +0 -100
  148. package/dist/chunk-B6DNOZCP.js +0 -369
  149. package/dist/chunk-BM4PYVOX.js +0 -109
  150. package/dist/chunk-C2SVCIWE.js +0 -57
  151. package/dist/chunk-CCUPDGSZ.js +0 -132
  152. package/dist/chunk-DBOWTYR4.js +0 -49
  153. package/dist/chunk-DFXNVEH6.js +0 -14
  154. package/dist/chunk-DX2524CZ.js +0 -314
  155. package/dist/chunk-GMJTLFM6.js +0 -60
  156. package/dist/chunk-IATIXMCE.js +0 -20
  157. package/dist/chunk-II4R3VVX.js +0 -25
  158. package/dist/chunk-JF2MDHOJ.js +0 -40
  159. package/dist/chunk-JQFUKJU5.js +0 -71
  160. package/dist/chunk-MI4UE2PQ.js +0 -561
  161. package/dist/chunk-PUKVXYYL.js +0 -52
  162. package/dist/chunk-QQS7I7ZL.js +0 -16
  163. package/dist/chunk-VAAMRG4K.js +0 -20
  164. package/dist/chunk-WFQJUJTC.js +0 -182
  165. package/dist/chunk-ZXIKIA5B.js +0 -178
  166. package/dist/concurrentCalls.cjs +0 -406
  167. package/dist/concurrentCalls.d.cts +0 -116
  168. package/dist/concurrentCalls.js +0 -346
  169. package/dist/consoleFmt.cjs +0 -85
  170. package/dist/consoleFmt.d.cts +0 -54
  171. package/dist/consoleFmt.d.ts +0 -54
  172. package/dist/consoleFmt.js +0 -60
  173. package/dist/conversions.cjs +0 -44
  174. package/dist/conversions.d.cts +0 -3
  175. package/dist/conversions.d.ts +0 -3
  176. package/dist/conversions.js +0 -6
  177. package/dist/createThrottleController.cjs +0 -193
  178. package/dist/createThrottleController.d.cts +0 -13
  179. package/dist/createThrottleController.d.ts +0 -13
  180. package/dist/createThrottleController.js +0 -61
  181. package/dist/debounce.cjs +0 -157
  182. package/dist/debounce.d.cts +0 -46
  183. package/dist/debounce.d.ts +0 -46
  184. package/dist/debounce.js +0 -8
  185. package/dist/dedent.cjs +0 -104
  186. package/dist/dedent.d.cts +0 -73
  187. package/dist/dedent.d.ts +0 -73
  188. package/dist/dedent.js +0 -79
  189. package/dist/deepEqual.cjs +0 -96
  190. package/dist/deepEqual.d.ts +0 -21
  191. package/dist/deepEqual.js +0 -8
  192. package/dist/deepReplaceValues.cjs +0 -87
  193. package/dist/deepReplaceValues.d.ts +0 -27
  194. package/dist/deepReplaceValues.js +0 -7
  195. package/dist/enhancedMap.cjs +0 -131
  196. package/dist/enhancedMap.d.cts +0 -20
  197. package/dist/enhancedMap.d.ts +0 -20
  198. package/dist/enhancedMap.js +0 -10
  199. package/dist/exhaustiveMatch.cjs +0 -66
  200. package/dist/exhaustiveMatch.d.cts +0 -9
  201. package/dist/exhaustiveMatch.d.ts +0 -9
  202. package/dist/exhaustiveMatch.js +0 -40
  203. package/dist/filterObjectOrArrayKeys.cjs +0 -619
  204. package/dist/filterObjectOrArrayKeys.d.ts +0 -88
  205. package/dist/filterObjectOrArrayKeys.js +0 -9
  206. package/dist/getAutoIncrementId.cjs +0 -44
  207. package/dist/getAutoIncrementId.d.ts +0 -46
  208. package/dist/getAutoIncrementId.js +0 -18
  209. package/dist/getCompositeKey.cjs +0 -86
  210. package/dist/getCompositeKey.d.ts +0 -11
  211. package/dist/getCompositeKey.js +0 -8
  212. package/dist/getValueStableKey.cjs +0 -89
  213. package/dist/getValueStableKey.d.ts +0 -15
  214. package/dist/getValueStableKey.js +0 -11
  215. package/dist/hash.cjs +0 -57
  216. package/dist/hash.d.ts +0 -7
  217. package/dist/hash.js +0 -32
  218. package/dist/interpolate.cjs +0 -88
  219. package/dist/interpolate.d.cts +0 -11
  220. package/dist/interpolate.d.ts +0 -11
  221. package/dist/interpolate.js +0 -46
  222. package/dist/iteratorUtils.cjs +0 -73
  223. package/dist/iteratorUtils.d.ts +0 -10
  224. package/dist/iteratorUtils.js +0 -44
  225. package/dist/keepPrevIfUnchanged.cjs +0 -102
  226. package/dist/keepPrevIfUnchanged.d.cts +0 -7
  227. package/dist/keepPrevIfUnchanged.d.ts +0 -7
  228. package/dist/keepPrevIfUnchanged.js +0 -7
  229. package/dist/keyedMap.cjs +0 -224
  230. package/dist/keyedMap.d.cts +0 -75
  231. package/dist/keyedMap.d.ts +0 -75
  232. package/dist/keyedMap.js +0 -145
  233. package/dist/keyedSet.cjs +0 -205
  234. package/dist/keyedSet.d.cts +0 -76
  235. package/dist/keyedSet.d.ts +0 -76
  236. package/dist/keyedSet.js +0 -126
  237. package/dist/levenshtein.cjs +0 -180
  238. package/dist/levenshtein.d.ts +0 -5
  239. package/dist/levenshtein.js +0 -153
  240. package/dist/main.cjs +0 -32
  241. package/dist/main.d.cts +0 -3
  242. package/dist/main.d.ts +0 -3
  243. package/dist/main.js +0 -7
  244. package/dist/matchPath.cjs +0 -155
  245. package/dist/matchPath.d.cts +0 -53
  246. package/dist/matchPath.d.ts +0 -53
  247. package/dist/matchPath.js +0 -108
  248. package/dist/mathUtils.cjs +0 -81
  249. package/dist/mathUtils.d.ts +0 -54
  250. package/dist/mathUtils.js +0 -22
  251. package/dist/mutationUtils.cjs +0 -153
  252. package/dist/mutationUtils.d.ts +0 -15
  253. package/dist/mutationUtils.js +0 -55
  254. package/dist/objUtils.cjs +0 -242
  255. package/dist/objUtils.d.cts +0 -28
  256. package/dist/objUtils.js +0 -38
  257. package/dist/parallelAsyncCalls.cjs +0 -162
  258. package/dist/parallelAsyncCalls.d.cts +0 -82
  259. package/dist/parallelAsyncCalls.d.ts +0 -82
  260. package/dist/parallelAsyncCalls.js +0 -126
  261. package/dist/partialEqual.cjs +0 -1196
  262. package/dist/partialEqual.d.cts +0 -141
  263. package/dist/partialEqual.d.ts +0 -141
  264. package/dist/partialEqual.js +0 -1168
  265. package/dist/promiseUtils.cjs +0 -38
  266. package/dist/promiseUtils.d.cts +0 -8
  267. package/dist/promiseUtils.d.ts +0 -8
  268. package/dist/promiseUtils.js +0 -6
  269. package/dist/regexUtils.cjs +0 -60
  270. package/dist/regexUtils.d.cts +0 -17
  271. package/dist/regexUtils.d.ts +0 -17
  272. package/dist/regexUtils.js +0 -33
  273. package/dist/retryOnError.cjs +0 -130
  274. package/dist/retryOnError.d.ts +0 -83
  275. package/dist/retryOnError.js +0 -101
  276. package/dist/runShellCmd.cjs +0 -127
  277. package/dist/runShellCmd.d.cts +0 -90
  278. package/dist/runShellCmd.js +0 -98
  279. package/dist/safeJson.cjs +0 -45
  280. package/dist/safeJson.d.ts +0 -16
  281. package/dist/safeJson.js +0 -8
  282. package/dist/saferTyping.cjs +0 -52
  283. package/dist/saferTyping.d.ts +0 -47
  284. package/dist/saferTyping.js +0 -23
  285. package/dist/serializeXML.cjs +0 -154
  286. package/dist/serializeXML.d.cts +0 -22
  287. package/dist/serializeXML.d.ts +0 -22
  288. package/dist/serializeXML.js +0 -116
  289. package/dist/shallowEqual.cjs +0 -88
  290. package/dist/shallowEqual.d.ts +0 -4
  291. package/dist/shallowEqual.js +0 -63
  292. package/dist/sleep.cjs +0 -32
  293. package/dist/sleep.d.cts +0 -3
  294. package/dist/sleep.d.ts +0 -3
  295. package/dist/sleep.js +0 -6
  296. package/dist/stringUtils.cjs +0 -155
  297. package/dist/stringUtils.d.ts +0 -55
  298. package/dist/stringUtils.js +0 -50
  299. package/dist/testUtils.cjs +0 -1490
  300. package/dist/testUtils.d.cts +0 -133
  301. package/dist/testUtils.js +0 -359
  302. package/dist/throttle.cjs +0 -282
  303. package/dist/throttle.d.cts +0 -98
  304. package/dist/throttle.js +0 -38
  305. package/dist/time.cjs +0 -152
  306. package/dist/time.d.cts +0 -25
  307. package/dist/time.js +0 -38
  308. package/dist/timers.cjs +0 -194
  309. package/dist/timers.d.ts +0 -121
  310. package/dist/timers.js +0 -156
  311. package/dist/tsResult.cjs +0 -226
  312. package/dist/tsResult.d.ts +0 -114
  313. package/dist/tsResult.js +0 -180
  314. package/dist/typeGuards.cjs +0 -70
  315. package/dist/typeGuards.d.ts +0 -111
  316. package/dist/typeGuards.js +0 -18
  317. package/dist/typeUtils.cjs +0 -18
  318. package/dist/typeUtils.d.cts +0 -61
  319. package/dist/typeUtils.js +0 -0
  320. package/dist/typedStrings.cjs +0 -90
  321. package/dist/typedStrings.d.ts +0 -163
  322. package/dist/typedStrings.js +0 -57
  323. package/dist/typingFnUtils.cjs +0 -96
  324. package/dist/typingFnUtils.d.ts +0 -100
  325. package/dist/typingFnUtils.js +0 -30
  326. package/dist/typingTestUtils.cjs +0 -52
  327. package/dist/typingTestUtils.d.ts +0 -79
  328. package/dist/typingTestUtils.js +0 -27
  329. package/dist/typingUtils.cjs +0 -18
  330. package/dist/typingUtils.d.cts +0 -35
  331. package/dist/typingUtils.d.ts +0 -35
  332. package/dist/typingUtils.js +0 -0
  333. package/dist/yamlStringify.cjs +0 -423
  334. package/dist/yamlStringify.d.cts +0 -10
  335. package/dist/yamlStringify.d.ts +0 -10
  336. package/dist/yamlStringify.js +0 -9
@@ -0,0 +1,121 @@
1
+ import { i as invariant, o as isObject } from "./assertions-qMxfVhSu.mjs";
2
+ import { sleep } from "./sleep.mjs";
3
+ import { Result, unknownToError } from "t-result";
4
+
5
+ //#region src/parallelAsyncCalls.ts
6
+ var ParallelAsyncResultCalls = class {
7
+ pendingCalls = [];
8
+ alreadyRun = false;
9
+ constructor() {}
10
+ add(call) {
11
+ this.pendingCalls.push(isObject(call) ? call : {
12
+ metadata: void 0,
13
+ fn: call
14
+ });
15
+ return this;
16
+ }
17
+ /**
18
+ * Adds calls return tuples with inferred results
19
+ *
20
+ * @param calls
21
+ */
22
+ addTuple(...calls) {
23
+ for (const call of calls) this.pendingCalls.push(isObject(call) ? call : {
24
+ metadata: void 0,
25
+ fn: call
26
+ });
27
+ return {
28
+ runAll: this.runAll.bind(this),
29
+ runAllSettled: this.runAllSettled.bind(this)
30
+ };
31
+ }
32
+ async runAllSettled({ delayStart } = {}) {
33
+ invariant(!this.alreadyRun, "Already run");
34
+ const asyncResults = await Promise.allSettled(this.pendingCalls.map(async (call, i) => {
35
+ try {
36
+ if (delayStart) await sleep(delayStart(i));
37
+ return {
38
+ result: await call.fn(),
39
+ callMetadata: call.metadata
40
+ };
41
+ } catch (exception) {
42
+ return {
43
+ result: Result.unknownToError(exception),
44
+ callMetadata: call.metadata
45
+ };
46
+ }
47
+ }));
48
+ const failed = [];
49
+ const succeeded = [];
50
+ const results = [];
51
+ for (const asyncResult of asyncResults) {
52
+ invariant(asyncResult.status === "fulfilled");
53
+ const { result, callMetadata } = asyncResult.value;
54
+ if (result.ok) {
55
+ const success = {
56
+ value: result.value,
57
+ metadata: callMetadata
58
+ };
59
+ results.push(success);
60
+ succeeded.push(success);
61
+ } else {
62
+ const fail = {
63
+ metadata: callMetadata,
64
+ error: result.error
65
+ };
66
+ results.push(fail);
67
+ failed.push(fail);
68
+ }
69
+ }
70
+ const allFailed = failed.length === this.pendingCalls.length;
71
+ this.alreadyRun = true;
72
+ this.pendingCalls = [];
73
+ return {
74
+ failed,
75
+ succeeded,
76
+ allFailed,
77
+ results
78
+ };
79
+ }
80
+ async runAll({ delayStart } = {}) {
81
+ invariant(!this.alreadyRun, "Already run");
82
+ try {
83
+ const asyncResults = await Promise.all(this.pendingCalls.map(async (call, i) => {
84
+ try {
85
+ if (delayStart) await sleep(delayStart(i));
86
+ const result = await call.fn();
87
+ if (!result.ok) throw result.error;
88
+ return {
89
+ value: result.value,
90
+ metadata: call.metadata
91
+ };
92
+ } catch (exception) {
93
+ throw {
94
+ metadata: call.metadata,
95
+ error: unknownToError(exception)
96
+ };
97
+ }
98
+ }));
99
+ return Result.ok(asyncResults);
100
+ } catch (exception) {
101
+ return Result.err(exception);
102
+ } finally {
103
+ this.alreadyRun = true;
104
+ this.pendingCalls = [];
105
+ }
106
+ }
107
+ };
108
+ /**
109
+ * Executes multiple asynchronous calls in parallel and collects the results in
110
+ * a easier to use format.
111
+ *
112
+ * @deprecated Use concurrentAsyncCalls instead.
113
+ * @template R - The type of the result value.
114
+ * @template M - The type of the call metadata.
115
+ */
116
+ function parallelAsyncCalls() {
117
+ return new ParallelAsyncResultCalls();
118
+ }
119
+
120
+ //#endregion
121
+ export { parallelAsyncCalls };
@@ -0,0 +1,139 @@
1
+ import { Result } from "t-result";
2
+
3
+ //#region src/partialEqual.d.ts
4
+ type ComparisonsType = [type: 'strStartsWith', value: string] | [type: 'strEndsWith', value: string] | [type: 'hasType', value: 'string' | 'number' | 'boolean' | 'object' | 'array' | 'function'] | [type: 'strContains', value: string] | [type: 'strMatchesRegex', value: RegExp] | [type: 'deepEqual', value: any] | [type: 'numIsGreaterThan', value: number] | [type: 'numIsGreaterThanOrEqual', value: number] | [type: 'numIsLessThan', value: number] | [type: 'numIsLessThanOrEqual', value: number] | [type: 'numIsInRange', value: [number, number]] | [type: 'arrayContains', value: any[]] | [type: 'arrayContainsInOrder', value: any[]] | [type: 'arrayStartsWith', value: any[]] | [type: 'arrayEndsWith', value: any[]] | [type: 'arrayLength', value: number] | [type: 'arrayMinLength', value: number] | [type: 'arrayMaxLength', value: number] | [type: 'arrayIncludes', value: any] | [type: 'arrayEvery', value: ComparisonsType] | [type: 'arraySome', value: ComparisonsType] | [type: 'jsonStringHasPartial', value: any] | [type: 'partialEqual', value: any] | [type: 'custom', value: (target: unknown) => boolean | {
5
+ error: string;
6
+ }] | [type: 'isInstanceOf', value: new (...args: any[]) => any] | [type: 'keyNotBePresent', value: null] | [type: 'not', value: ComparisonsType] | [type: 'any', value: ComparisonsType[]] | [type: 'all', value: ComparisonsType[]] | [type: 'withNoExtraKeys', partialShape: any] | [type: 'withDeepNoExtraKeys', partialShape: any] | [type: 'noExtraDefinedKeys', partialShape: any] | [type: 'deepNoExtraDefinedKeys', partialShape: any];
7
+ type KeyComparisonPrefix = 'pqkc' | 'pqkc-not';
8
+ type KeyComparison = {
9
+ any: `$${KeyComparisonPrefix}:any$`;
10
+ anyOther: `$${KeyComparisonPrefix}:anyOther$`;
11
+ numeric: `$${KeyComparisonPrefix}:numeric$`;
12
+ startingWith: `$${KeyComparisonPrefix}:startingWith:${string}$`;
13
+ endingWith: `$${KeyComparisonPrefix}:endingWith:${string}$`;
14
+ contains: `$${KeyComparisonPrefix}:contains:${string}$`;
15
+ matchesRegex: `$${KeyComparisonPrefix}:matchesRegex:${string}$`;
16
+ };
17
+ type Comparison = {
18
+ '~sc': ComparisonsType;
19
+ };
20
+ type BaseMatch = {
21
+ noExtraKeys: (partialShape: any) => Comparison;
22
+ deepNoExtraKeys: (partialShape: any) => Comparison;
23
+ noExtraDefinedKeys: (partialShape: any) => Comparison;
24
+ deepNoExtraDefinedKeys: (partialShape: any) => Comparison;
25
+ hasType: {
26
+ string: Comparison;
27
+ number: Comparison;
28
+ boolean: Comparison;
29
+ object: Comparison;
30
+ array: Comparison;
31
+ function: Comparison;
32
+ };
33
+ isInstanceOf: (constructor: new (...args: any[]) => any) => Comparison;
34
+ str: {
35
+ contains: (substring: string) => Comparison;
36
+ startsWith: (substring: string) => Comparison;
37
+ endsWith: (substring: string) => Comparison;
38
+ matchesRegex: (regex: RegExp) => Comparison;
39
+ };
40
+ num: {
41
+ isGreaterThan: (value: number) => Comparison;
42
+ isGreaterThanOrEqual: (value: number) => Comparison;
43
+ isLessThan: (value: number) => Comparison;
44
+ isLessThanOrEqual: (value: number) => Comparison;
45
+ isInRange: (value: [number, number]) => Comparison;
46
+ };
47
+ array: {
48
+ contains: (elements: any[]) => Comparison;
49
+ containsInOrder: (elements: any[]) => Comparison;
50
+ startsWith: (elements: any[]) => Comparison;
51
+ endsWith: (elements: any[]) => Comparison;
52
+ length: (n: number) => Comparison;
53
+ minLength: (n: number) => Comparison;
54
+ maxLength: (n: number) => Comparison;
55
+ includes: (element: any) => Comparison;
56
+ every: (matcher: Comparison) => Comparison;
57
+ some: (matcher: Comparison) => Comparison;
58
+ };
59
+ jsonString: {
60
+ hasPartial: (value: any) => Comparison;
61
+ };
62
+ equal: (value: any) => Comparison;
63
+ partialEqual: (value: any) => Comparison;
64
+ custom: (isEqual: (value: unknown) => boolean | {
65
+ error: string;
66
+ }) => Comparison;
67
+ keyNotBePresent: Comparison;
68
+ any: (...values: any[]) => Comparison;
69
+ all: (...values: any[]) => Comparison;
70
+ key: {
71
+ any: KeyComparison['any'];
72
+ anyOther: KeyComparison['anyOther'];
73
+ numeric: KeyComparison['numeric'];
74
+ startingWith: (substring: string) => KeyComparison['startingWith'];
75
+ endingWith: (substring: string) => KeyComparison['endingWith'];
76
+ containing: (substring: string) => KeyComparison['contains'];
77
+ matchingRegex: (regex: RegExp) => KeyComparison['matchesRegex'];
78
+ };
79
+ };
80
+ type Match = BaseMatch & {
81
+ not: BaseMatch;
82
+ };
83
+ declare const match: Match;
84
+ type PartialError = {
85
+ path: string;
86
+ message: string;
87
+ received?: any;
88
+ expected?: any;
89
+ };
90
+ /**
91
+ * Checks if sub is a partial match of target (all properties in sub exist and
92
+ * match in target). Supports special comparison matchers for flexible pattern
93
+ * matching.
94
+ *
95
+ * @example
96
+ * // Basic partial matching
97
+ * partialEqual({ a: 1, b: 2 }, { a: 1 }); // true - sub is subset of target
98
+ * partialEqual([1, 2, 3], [1, 2]); // true - sub array is prefix of target (default behavior)
99
+ *
100
+ * // Array matching (default behavior: prefix matching)
101
+ * partialEqual([1, 2, 3, 4], [1, 2]); // true - checks first 2 elements
102
+ * partialEqual([1, 3, 4], [1, 2]); // false - second element doesn't match
103
+ *
104
+ * // Advanced array matchers for flexible matching
105
+ * partialEqual([1, 2, 3, 4, 5], match.array.contains([3, 1])); // true - contains elements anywhere
106
+ * partialEqual([1, 2, 3, 4, 5], match.array.containsInOrder([2, 4])); // true - contains in order (non-consecutive)
107
+ * partialEqual([1, 2, 3], match.array.startsWith([1, 2])); // true - explicit prefix matching
108
+ * partialEqual([1, 2, 3], match.array.endsWith([2, 3])); // true - suffix matching
109
+ * partialEqual([1, 2, 3], match.array.length(3)); // true - exact length
110
+ * partialEqual([1, 2, 3], match.array.includes(2)); // true - includes element
111
+ * partialEqual(
112
+ * [10, 20, 30],
113
+ * match.array.every(match.num.isGreaterThan(5)),
114
+ * ); // true - all elements match
115
+ * partialEqual([1, 10, 3], match.array.some(match.num.isGreaterThan(8))); // true - at least one matches
116
+ *
117
+ * // Special comparisons
118
+ * partialEqual('hello world', match.str.contains('world')); // true
119
+ * partialEqual(25, match.num.isGreaterThan(18)); // true
120
+ * partialEqual(
121
+ * 'test@example.com',
122
+ * match.custom((v) => typeof v === 'string' && v.includes('@')),
123
+ * ); // true
124
+ *
125
+ * // Complex nested matching
126
+ * partialEqual(
127
+ * { user: { name: 'John', age: 30 } },
128
+ * {
129
+ * user: {
130
+ * name: match.str.startsWith('J'),
131
+ * age: match.num.isGreaterThan(25),
132
+ * },
133
+ * },
134
+ * ); // true
135
+ */
136
+ declare function partialEqual(target: any, sub: any, returnErrors: true): Result<void, PartialError[]>;
137
+ declare function partialEqual(target: any, sub: any): boolean;
138
+ //#endregion
139
+ export { match, partialEqual };