@ezez/utils 4.0.0 → 4.1.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 (414) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist/cap.js.map +1 -1
  3. package/dist/coalesce.d.ts.map +1 -1
  4. package/dist/coalesce.js.map +1 -1
  5. package/dist/compareArrays.d.ts.map +1 -1
  6. package/dist/compareProps.d.ts.map +1 -1
  7. package/dist/compareProps.js.map +1 -1
  8. package/dist/deserialize.d.ts.map +1 -1
  9. package/dist/deserialize.js.map +1 -1
  10. package/dist/ensureArray.d.ts.map +1 -1
  11. package/dist/ensureArray.js.map +1 -1
  12. package/dist/ensureDate.js.map +1 -1
  13. package/dist/ensureError.js.map +1 -1
  14. package/dist/ensurePrefix.js.map +1 -1
  15. package/dist/ensureSuffix.js.map +1 -1
  16. package/dist/ensureTimestamp.js.map +1 -1
  17. package/dist/escapeRegExp.d.ts.map +1 -1
  18. package/dist/escapeRegExp.js +1 -1
  19. package/dist/escapeRegExp.js.map +1 -1
  20. package/dist/formatDate.js +1 -1
  21. package/dist/formatDate.js.map +1 -1
  22. package/dist/get.js.map +1 -1
  23. package/dist/getMultiple.d.ts.map +1 -1
  24. package/dist/getMultiple.js.map +1 -1
  25. package/dist/index.d.ts +1 -0
  26. package/dist/index.d.ts.map +1 -1
  27. package/dist/index.js +1 -0
  28. package/dist/index.js.map +1 -1
  29. package/dist/insertSeparator.d.ts.map +1 -1
  30. package/dist/insertSeparator.js.map +1 -1
  31. package/dist/isEmpty.js.map +1 -1
  32. package/dist/isNumericString.js +1 -1
  33. package/dist/isNumericString.js.map +1 -1
  34. package/dist/last.d.ts.map +1 -1
  35. package/dist/later.d.ts.map +1 -1
  36. package/dist/mapAsync.d.ts.map +1 -1
  37. package/dist/mapAsync.js.map +1 -1
  38. package/dist/mapValues.d.ts.map +1 -1
  39. package/dist/mapValues.js.map +1 -1
  40. package/dist/match.d.ts.map +1 -1
  41. package/dist/match.js.map +1 -1
  42. package/dist/memoize.d.ts +3 -0
  43. package/dist/memoize.d.ts.map +1 -0
  44. package/dist/memoize.js +19 -0
  45. package/dist/memoize.js.map +1 -0
  46. package/dist/merge.d.ts +11 -7
  47. package/dist/merge.d.ts.map +1 -1
  48. package/dist/merge.js.map +1 -1
  49. package/dist/mostFrequent.d.ts.map +1 -1
  50. package/dist/mostFrequent.js.map +1 -1
  51. package/dist/occurrences.js.map +1 -1
  52. package/dist/omit.d.ts.map +1 -1
  53. package/dist/omit.js.map +1 -1
  54. package/dist/pick.d.ts.map +1 -1
  55. package/dist/pick.js.map +1 -1
  56. package/dist/pull.d.ts.map +1 -1
  57. package/dist/pull.js.map +1 -1
  58. package/dist/remove.d.ts.map +1 -1
  59. package/dist/remove.js +1 -1
  60. package/dist/remove.js.map +1 -1
  61. package/dist/removeCommonProperties.d.ts.map +1 -1
  62. package/dist/removeCommonProperties.js +3 -1
  63. package/dist/removeCommonProperties.js.map +1 -1
  64. package/dist/replace.js +1 -1
  65. package/dist/replace.js.map +1 -1
  66. package/dist/replaceDeep.d.ts.map +1 -1
  67. package/dist/replaceDeepByFn.d.ts.map +1 -1
  68. package/dist/replaceDeepByFn.js.map +1 -1
  69. package/dist/safe.js.map +1 -1
  70. package/dist/sample.d.ts +3 -1
  71. package/dist/sample.d.ts.map +1 -1
  72. package/dist/sample.js.map +1 -1
  73. package/dist/samples.d.ts.map +1 -1
  74. package/dist/samples.js.map +1 -1
  75. package/dist/seq.d.ts.map +1 -1
  76. package/dist/seq.js +1 -1
  77. package/dist/seq.js.map +1 -1
  78. package/dist/serialize.js.map +1 -1
  79. package/dist/set.js.map +1 -1
  80. package/dist/setImmutable.js.map +1 -1
  81. package/dist/shuffle.d.ts.map +1 -1
  82. package/dist/sortBy.d.ts.map +1 -1
  83. package/dist/sortBy.js.map +1 -1
  84. package/dist/sortProps.d.ts.map +1 -1
  85. package/dist/sortProps.js.map +1 -1
  86. package/dist/stripPrefix.js.map +1 -1
  87. package/dist/stripSuffix.js.map +1 -1
  88. package/dist/throttle.d.ts.map +1 -1
  89. package/dist/throttle.js.map +1 -1
  90. package/dist/toggle.d.ts.map +1 -1
  91. package/dist/toggle.js.map +1 -1
  92. package/dist/trimEnd.js.map +1 -1
  93. package/dist/trimStart.js.map +1 -1
  94. package/dist/truthy.d.ts +1 -1
  95. package/dist/truthy.d.ts.map +1 -1
  96. package/dist/unique.d.ts.map +1 -1
  97. package/dist/waitFor.d.ts.map +1 -1
  98. package/dist/waitFor.js +1 -1
  99. package/dist/waitFor.js.map +1 -1
  100. package/dist/waitSync.js.map +1 -1
  101. package/docs/assets/icons.js +15 -0
  102. package/docs/assets/icons.svg +1 -0
  103. package/docs/assets/main.js +4 -3
  104. package/docs/assets/navigation.js +1 -0
  105. package/docs/assets/search.js +1 -1
  106. package/docs/assets/style.css +544 -394
  107. package/docs/documents/CHANGELOG.html +337 -0
  108. package/docs/functions/index.cap.html +5 -0
  109. package/docs/functions/index.capitalize.html +13 -0
  110. package/docs/functions/index.coalesce.html +16 -0
  111. package/docs/functions/index.compareArrays.html +8 -0
  112. package/docs/functions/index.compareProps.html +11 -0
  113. package/docs/functions/index.deserialize.html +6 -0
  114. package/docs/functions/index.ensureArray.html +3 -0
  115. package/docs/functions/index.ensureDate.html +10 -0
  116. package/docs/functions/index.ensureError.html +14 -0
  117. package/docs/functions/index.ensurePrefix.html +10 -0
  118. package/docs/functions/index.ensureSuffix.html +10 -0
  119. package/docs/functions/index.ensureTimestamp.html +10 -0
  120. package/docs/functions/index.escapeRegExp.html +7 -0
  121. package/docs/functions/index.formatDate.html +6 -0
  122. package/docs/functions/index.get.html +26 -0
  123. package/docs/functions/index.getMultiple.html +16 -0
  124. package/docs/functions/index.insertSeparator.html +7 -0
  125. package/docs/functions/index.isEmpty.html +33 -0
  126. package/docs/functions/index.isNumericString.html +5 -0
  127. package/docs/functions/index.isPlainObject.html +18 -0
  128. package/docs/functions/index.last.html +15 -0
  129. package/docs/functions/index.later-1.html +6 -0
  130. package/docs/functions/index.mapAsync.html +8 -0
  131. package/docs/functions/index.mapValues.html +14 -0
  132. package/docs/functions/index.match.html +4 -0
  133. package/docs/functions/index.memoize.html +8 -0
  134. package/docs/functions/index.merge.html +13 -0
  135. package/docs/functions/index.mostFrequent.html +2 -0
  136. package/docs/functions/index.noop.html +2 -0
  137. package/docs/functions/index.occurrences.html +14 -0
  138. package/docs/functions/index.omit.html +18 -0
  139. package/docs/functions/index.pick.html +13 -0
  140. package/docs/functions/index.pull.html +2 -0
  141. package/docs/functions/index.remove.html +2 -0
  142. package/docs/functions/index.removeCommonProperties.html +18 -0
  143. package/docs/functions/index.replace.html +10 -0
  144. package/docs/functions/index.replaceDeep.html +15 -0
  145. package/docs/functions/index.rethrow.html +2 -0
  146. package/docs/functions/index.round.html +7 -0
  147. package/docs/functions/index.safe.html +7 -0
  148. package/docs/functions/index.sample.html +6 -0
  149. package/docs/functions/index.samples.html +7 -0
  150. package/docs/functions/index.scale.html +5 -0
  151. package/docs/functions/index.seq.html +17 -0
  152. package/docs/functions/index.seqEarlyBreak.html +12 -0
  153. package/docs/functions/index.serialize.html +14 -0
  154. package/docs/functions/index.set.html +26 -0
  155. package/docs/functions/index.setImmutable.html +25 -0
  156. package/docs/functions/index.shuffle.html +3 -0
  157. package/docs/functions/index.sortBy.html +6 -0
  158. package/docs/functions/index.sortProps.html +10 -0
  159. package/docs/functions/index.stripPrefix.html +4 -0
  160. package/docs/functions/index.stripSuffix.html +4 -0
  161. package/docs/functions/index.throttle.html +14 -0
  162. package/docs/functions/index.toggle.html +5 -0
  163. package/docs/functions/index.trim.html +8 -0
  164. package/docs/functions/index.trimEnd.html +8 -0
  165. package/docs/functions/index.trimStart.html +8 -0
  166. package/docs/functions/index.truthy.html +7 -0
  167. package/docs/functions/index.unique.html +6 -0
  168. package/docs/functions/index.wait.html +3 -0
  169. package/docs/functions/index.waitFor.html +10 -0
  170. package/docs/functions/index.waitSync.html +3 -0
  171. package/docs/index.html +18 -207
  172. package/docs/interfaces/index.ComparePropsOptions.html +5 -0
  173. package/docs/interfaces/index.GetMultipleSource.html +3 -0
  174. package/docs/interfaces/index.GetSource.html +3 -0
  175. package/docs/interfaces/index.IsNumericStringOptions.html +5 -0
  176. package/docs/interfaces/index.OccurencesOptions.html +3 -0
  177. package/docs/interfaces/index.SetImmutableSource.html +3 -0
  178. package/docs/interfaces/index.SetSource.html +3 -0
  179. package/docs/interfaces/index.ThrottleOptions.html +5 -0
  180. package/docs/interfaces/index.ThrottledFunctionExtras.html +5 -0
  181. package/docs/modules/index.html +86 -0
  182. package/docs/types/index.CustomDeserializers.html +1 -0
  183. package/docs/types/index.CustomSerializers.html +1 -0
  184. package/docs/types/index.Later.html +4 -0
  185. package/docs/types/index.MapValuesFn.html +14 -0
  186. package/docs/types/index.MatchCallback.html +1 -0
  187. package/docs/types/index.MergeTwo.html +3 -0
  188. package/docs/types/index.SeqEarlyBreaker.html +4 -0
  189. package/docs/types/index.SeqFn.html +3 -0
  190. package/docs/types/index.SeqFunctions.html +4 -0
  191. package/docs/types/index.SetImmutablePath.html +4 -0
  192. package/docs/types/index.ThrottledFunction.html +1 -0
  193. package/docs/variables/index.mapValuesUNSET.html +2 -0
  194. package/docs/variables/index.mergeUNSET.html +4 -0
  195. package/esm/cap.js.map +1 -1
  196. package/esm/coalesce.d.ts.map +1 -1
  197. package/esm/coalesce.js.map +1 -1
  198. package/esm/compareArrays.d.ts.map +1 -1
  199. package/esm/compareProps.d.ts.map +1 -1
  200. package/esm/compareProps.js.map +1 -1
  201. package/esm/deserialize.d.ts.map +1 -1
  202. package/esm/deserialize.js.map +1 -1
  203. package/esm/ensureArray.d.ts.map +1 -1
  204. package/esm/ensureArray.js.map +1 -1
  205. package/esm/ensureDate.js.map +1 -1
  206. package/esm/ensureError.js.map +1 -1
  207. package/esm/ensurePrefix.js.map +1 -1
  208. package/esm/ensureSuffix.js.map +1 -1
  209. package/esm/ensureTimestamp.js.map +1 -1
  210. package/esm/escapeRegExp.d.ts.map +1 -1
  211. package/esm/escapeRegExp.js +1 -1
  212. package/esm/escapeRegExp.js.map +1 -1
  213. package/esm/formatDate.js +1 -1
  214. package/esm/formatDate.js.map +1 -1
  215. package/esm/get.js.map +1 -1
  216. package/esm/getMultiple.d.ts.map +1 -1
  217. package/esm/getMultiple.js.map +1 -1
  218. package/esm/index.d.ts +1 -0
  219. package/esm/index.d.ts.map +1 -1
  220. package/esm/index.js +1 -0
  221. package/esm/index.js.map +1 -1
  222. package/esm/insertSeparator.d.ts.map +1 -1
  223. package/esm/insertSeparator.js.map +1 -1
  224. package/esm/isEmpty.js.map +1 -1
  225. package/esm/isNumericString.js +1 -1
  226. package/esm/isNumericString.js.map +1 -1
  227. package/esm/last.d.ts.map +1 -1
  228. package/esm/later.d.ts.map +1 -1
  229. package/esm/mapAsync.d.ts.map +1 -1
  230. package/esm/mapAsync.js.map +1 -1
  231. package/esm/mapValues.d.ts.map +1 -1
  232. package/esm/mapValues.js.map +1 -1
  233. package/esm/match.d.ts.map +1 -1
  234. package/esm/match.js.map +1 -1
  235. package/esm/memoize.d.ts +3 -0
  236. package/esm/memoize.d.ts.map +1 -0
  237. package/esm/memoize.js +16 -0
  238. package/esm/memoize.js.map +1 -0
  239. package/esm/merge.d.ts +11 -7
  240. package/esm/merge.d.ts.map +1 -1
  241. package/esm/merge.js.map +1 -1
  242. package/esm/mostFrequent.d.ts.map +1 -1
  243. package/esm/mostFrequent.js.map +1 -1
  244. package/esm/occurrences.js.map +1 -1
  245. package/esm/omit.d.ts.map +1 -1
  246. package/esm/omit.js.map +1 -1
  247. package/esm/pick.d.ts.map +1 -1
  248. package/esm/pick.js.map +1 -1
  249. package/esm/pull.d.ts.map +1 -1
  250. package/esm/pull.js.map +1 -1
  251. package/esm/remove.d.ts.map +1 -1
  252. package/esm/remove.js +1 -1
  253. package/esm/remove.js.map +1 -1
  254. package/esm/removeCommonProperties.d.ts.map +1 -1
  255. package/esm/removeCommonProperties.js +3 -1
  256. package/esm/removeCommonProperties.js.map +1 -1
  257. package/esm/replace.js +1 -1
  258. package/esm/replace.js.map +1 -1
  259. package/esm/replaceDeep.d.ts.map +1 -1
  260. package/esm/replaceDeepByFn.d.ts.map +1 -1
  261. package/esm/replaceDeepByFn.js.map +1 -1
  262. package/esm/safe.js.map +1 -1
  263. package/esm/sample.d.ts +3 -1
  264. package/esm/sample.d.ts.map +1 -1
  265. package/esm/sample.js.map +1 -1
  266. package/esm/samples.d.ts.map +1 -1
  267. package/esm/samples.js.map +1 -1
  268. package/esm/seq.d.ts.map +1 -1
  269. package/esm/seq.js +1 -1
  270. package/esm/seq.js.map +1 -1
  271. package/esm/serialize.js.map +1 -1
  272. package/esm/set.js.map +1 -1
  273. package/esm/setImmutable.js.map +1 -1
  274. package/esm/shuffle.d.ts.map +1 -1
  275. package/esm/sortBy.d.ts.map +1 -1
  276. package/esm/sortBy.js.map +1 -1
  277. package/esm/sortProps.d.ts.map +1 -1
  278. package/esm/sortProps.js.map +1 -1
  279. package/esm/stripPrefix.js.map +1 -1
  280. package/esm/stripSuffix.js.map +1 -1
  281. package/esm/throttle.d.ts.map +1 -1
  282. package/esm/throttle.js.map +1 -1
  283. package/esm/toggle.d.ts.map +1 -1
  284. package/esm/toggle.js.map +1 -1
  285. package/esm/trimEnd.js.map +1 -1
  286. package/esm/trimStart.js.map +1 -1
  287. package/esm/truthy.d.ts +1 -1
  288. package/esm/truthy.d.ts.map +1 -1
  289. package/esm/unique.d.ts.map +1 -1
  290. package/esm/waitFor.d.ts.map +1 -1
  291. package/esm/waitFor.js +1 -1
  292. package/esm/waitFor.js.map +1 -1
  293. package/esm/waitSync.js.map +1 -1
  294. package/package.json +10 -17
  295. package/pnpm-lock.yaml +661 -386
  296. package/src/compareProps.ts +9 -2
  297. package/src/deserialize.spec.ts +1 -0
  298. package/src/escapeRegExp.spec.ts +5 -3
  299. package/src/escapeRegExp.ts +3 -2
  300. package/src/formatDate.ts +2 -2
  301. package/src/get.spec.ts +1 -0
  302. package/src/getMultiple.ts +1 -0
  303. package/src/index.ts +1 -0
  304. package/src/isNumericString.ts +3 -3
  305. package/src/memoize.spec.ts +90 -0
  306. package/src/memoize.ts +35 -0
  307. package/src/merge.ts +30 -8
  308. package/src/mostFrequent.ts +1 -0
  309. package/src/remove.ts +1 -1
  310. package/src/removeCommonProperties.ts +4 -2
  311. package/src/replace.ts +1 -1
  312. package/src/rethrow.ts +1 -1
  313. package/src/sample.spec.ts +1 -0
  314. package/src/sample.ts +18 -2
  315. package/src/samples.ts +1 -1
  316. package/src/seq.spec.ts +6 -3
  317. package/src/seq.ts +1 -1
  318. package/src/serialize.spec.ts +1 -0
  319. package/src/serialize.ts +1 -1
  320. package/src/set.ts +1 -1
  321. package/src/setImmutable.ts +1 -1
  322. package/src/sortBy.ts +1 -1
  323. package/src/throttle.ts +1 -1
  324. package/src/waitFor.spec.ts +7 -2
  325. package/src/waitFor.ts +1 -1
  326. package/typedoc.cjs +2 -4
  327. package/docs/assets/pages.css +0 -14
  328. package/docs/functions/cap.html +0 -152
  329. package/docs/functions/capitalize.html +0 -157
  330. package/docs/functions/coalesce.html +0 -162
  331. package/docs/functions/compareArrays.html +0 -165
  332. package/docs/functions/compareProps.html +0 -164
  333. package/docs/functions/deserialize.html +0 -156
  334. package/docs/functions/ensureArray.html +0 -150
  335. package/docs/functions/ensureDate.html +0 -152
  336. package/docs/functions/ensureError.html +0 -156
  337. package/docs/functions/ensurePrefix.html +0 -154
  338. package/docs/functions/ensureSuffix.html +0 -154
  339. package/docs/functions/ensureTimestamp.html +0 -152
  340. package/docs/functions/escapeRegExp.html +0 -148
  341. package/docs/functions/formatDate.html +0 -150
  342. package/docs/functions/get.html +0 -174
  343. package/docs/functions/getMultiple.html +0 -165
  344. package/docs/functions/insertSeparator.html +0 -159
  345. package/docs/functions/isEmpty.html +0 -175
  346. package/docs/functions/isNumericString.html +0 -149
  347. package/docs/functions/isPlainObject.html +0 -159
  348. package/docs/functions/last.html +0 -162
  349. package/docs/functions/later-1.html +0 -147
  350. package/docs/functions/mapAsync.html +0 -180
  351. package/docs/functions/mapValues.html +0 -166
  352. package/docs/functions/match.html +0 -158
  353. package/docs/functions/merge.html +0 -500
  354. package/docs/functions/mostFrequent.html +0 -147
  355. package/docs/functions/noop.html +0 -137
  356. package/docs/functions/occurrences.html +0 -161
  357. package/docs/functions/omit.html +0 -169
  358. package/docs/functions/pick.html +0 -165
  359. package/docs/functions/pull.html +0 -149
  360. package/docs/functions/remove.html +0 -165
  361. package/docs/functions/removeCommonProperties.html +0 -164
  362. package/docs/functions/replace.html +0 -154
  363. package/docs/functions/replaceDeep.html +0 -170
  364. package/docs/functions/rethrow.html +0 -142
  365. package/docs/functions/round.html +0 -151
  366. package/docs/functions/safe.html +0 -192
  367. package/docs/functions/sample.html +0 -149
  368. package/docs/functions/samples.html +0 -159
  369. package/docs/functions/scale.html +0 -153
  370. package/docs/functions/seq.html +0 -164
  371. package/docs/functions/seqEarlyBreak.html +0 -162
  372. package/docs/functions/serialize.html +0 -161
  373. package/docs/functions/set.html +0 -174
  374. package/docs/functions/setImmutable.html +0 -173
  375. package/docs/functions/shuffle.html +0 -149
  376. package/docs/functions/sortBy.html +0 -171
  377. package/docs/functions/sortProps.html +0 -159
  378. package/docs/functions/stripPrefix.html +0 -148
  379. package/docs/functions/stripSuffix.html +0 -148
  380. package/docs/functions/throttle.html +0 -167
  381. package/docs/functions/toggle.html +0 -154
  382. package/docs/functions/trim.html +0 -152
  383. package/docs/functions/trimEnd.html +0 -152
  384. package/docs/functions/trimStart.html +0 -152
  385. package/docs/functions/truthy.html +0 -154
  386. package/docs/functions/unique.html +0 -152
  387. package/docs/functions/wait.html +0 -145
  388. package/docs/functions/waitFor.html +0 -164
  389. package/docs/functions/waitSync.html +0 -145
  390. package/docs/interfaces/ComparePropsOptions.html +0 -70
  391. package/docs/interfaces/GetMultipleSource.html +0 -142
  392. package/docs/interfaces/GetSource.html +0 -142
  393. package/docs/interfaces/IsNumericStringOptions.html +0 -91
  394. package/docs/interfaces/OccurencesOptions.html +0 -72
  395. package/docs/interfaces/SetImmutableSource.html +0 -142
  396. package/docs/interfaces/SetSource.html +0 -142
  397. package/docs/interfaces/ThrottleOptions.html +0 -81
  398. package/docs/interfaces/ThrottledFunctionExtras.html +0 -97
  399. package/docs/modules.html +0 -223
  400. package/docs/pages/CHANGELOG.html +0 -973
  401. package/docs/pages/Introduction.html +0 -130
  402. package/docs/types/CustomDeserializers.html +0 -159
  403. package/docs/types/CustomSerializers.html +0 -159
  404. package/docs/types/Later.html +0 -173
  405. package/docs/types/MapValuesFn.html +0 -170
  406. package/docs/types/MatchCallback.html +0 -149
  407. package/docs/types/SeqEarlyBreaker.html +0 -150
  408. package/docs/types/SeqFn.html +0 -148
  409. package/docs/types/SeqFunctions.html +0 -141
  410. package/docs/types/SetImmutablePath.html +0 -135
  411. package/docs/types/ThrottledFunction.html +0 -149
  412. package/docs/variables/mapValuesUNSET.html +0 -137
  413. package/docs/variables/mergeUNSET.html +0 -139
  414. package/tutorials/Introduction.md +0 -1
package/docs/functions/index.waitFor.html ADDED
@@ -0,0 +1,10 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>waitFor | @ezez/utils - v4.1.0</title><meta name="description" content="Documentation for @ezez/utils"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@ezez/utils - v4.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@ezez/utils</a></li><li><a href="../modules/index.html">index</a></li><li><a href="index.waitFor.html">waitFor</a></li></ul><h1>Function waitFor</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Runs the callback function every specified interval and returns a Promise that resolves when the callback returns
2
+ any other value than <code>null</code>, <code>undefined</code> or <code>false</code>.
3
+ If your callback throws (or Promise rejects) it will stop the interval and reject the returned Promise.
4
+ To avoid that use:</p>
5
+ <pre><code class="typescript"><span class="hl-2">waitFor</span><span class="hl-1">(() </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-2">promiseReturningFunction</span><span class="hl-1">().</span><span class="hl-2">catch</span><span class="hl-1">(() </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-0">null</span><span class="hl-1">));</span><br/><span class="hl-6">// or</span><br/><span class="hl-2">waitFor</span><span class="hl-1">(() </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-2">safe</span><span class="hl-1">(() </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-2">functionThatThrows</span><span class="hl-1">()));</span>
6
+ </code><button type="button">Copy</button></pre>
7
+
8
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="waitFor" class="tsd-anchor"></a><span class="tsd-kind-call-signature">wait<wbr/>For</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.waitFor.html#waitFor.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.waitFor.html#waitFor.T">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#waitFor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="waitFor.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">MaybePromise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.waitFor.html#waitFor.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>callback function</p>
9
+ </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MaybePromise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.waitFor.html#waitFor.T">T</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MaybePromise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.waitFor.html#waitFor.T">T</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Options</span><span class="tsd-signature-symbol"> = defaultOptions</span></span><div class="tsd-comment tsd-typography"><p>options object</p>
10
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.waitFor.html#waitFor.T">T</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dzek69/bottom-line/blob/e3307393551770c659e984ef501ad00f2839ca27/src/waitFor.ts#L42">waitFor.ts:42</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@ezez/utils - v4.1.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/functions/index.waitSync.html ADDED
@@ -0,0 +1,3 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>waitSync | @ezez/utils - v4.1.0</title><meta name="description" content="Documentation for @ezez/utils"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@ezez/utils - v4.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@ezez/utils</a></li><li><a href="../modules/index.html">index</a></li><li><a href="index.waitSync.html">waitSync</a></li></ul><h1>Function waitSync</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Synchronously wait for a given time, blocking the event loop [!]</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="waitSync" class="tsd-anchor"></a><span class="tsd-kind-call-signature">wait<wbr/>Sync</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timeMs</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#waitSync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">timeMs</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span><div class="tsd-comment tsd-typography"><p>time to wait</p>
3
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dzek69/bottom-line/blob/e3307393551770c659e984ef501ad00f2839ca27/src/waitSync.ts#L6">waitSync.ts:6</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@ezez/utils - v4.1.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/index.html CHANGED
@@ -1,42 +1,12 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@ezez/utils - v4.0.0</title><meta name="description" content="Documentation for @ezez/utils - v4.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script><link rel="stylesheet" href="assets/pages.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
- <div class="tsd-toolbar-contents container">
3
- <div class="table-cell" id="tsd-search" data-base=".">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
- <div class="field">
6
- <div id="tsd-toolbar-links"></div></div>
7
- <ul class="results">
8
- <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@ezez/utils - v4.0.0</a></div>
10
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
- <div class="container container-main">
12
- <div class="col-8 col-content">
13
- <div class="tsd-page-title">
14
- <h2>@ezez/utils - v4.0.0</h2></div>
15
- <div class="tsd-panel tsd-typography">
16
- <a href="#ezezutils" id="ezezutils" style="color: inherit; text-decoration: none;">
17
- <h1>@ezez/utils</h1>
18
- </a>
19
- <blockquote>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@ezez/utils - v4.1.0</title><meta name="description" content="Documentation for @ezez/utils"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@ezez/utils - v4.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@ezez/utils - v4.1.0</h2></div><div class="tsd-panel tsd-typography"><a id="md:ezezutils" class="tsd-anchor"></a><h1 class="tsd-anchor-link">@ezez/utils<a href="#md:ezezutils" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><blockquote>
20
2
  <p>Formerly: bottom-line-utils, but I never liked the name</p>
21
3
  </blockquote>
22
4
  <p>A tiny and fast utils library.</p>
23
-
24
- <a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
25
- <h2>Documentation</h2>
26
- </a>
27
- <p>Documentation can be found here: <a href="https://ezez.dev/docs/utils/latest">documentation</a>.</p>
28
-
29
- <a href="#installing" id="installing" style="color: inherit; text-decoration: none;">
30
- <h2>Installing</h2>
31
- </a>
32
- <p><code>npm install @ezez/utils</code></p>
33
-
34
- <a href="#motivation" id="motivation" style="color: inherit; text-decoration: none;">
35
- <h2>Motivation</h2>
36
- </a>
37
- <p>Lodash complexity that causes big bundle sizes just for using single function (even with tree shaking!).</p>
5
+ <a id="md:documentation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Documentation<a href="#md:documentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Documentation can be found here: <a href="https://ezez.dev/docs/utils/latest">documentation</a>.</p>
6
+ <a id="md:installing" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Installing<a href="#md:installing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><code>npm install @ezez/utils</code></p>
7
+ <a id="md:motivation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Motivation<a href="#md:motivation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Lodash complexity that causes big bundle sizes just for using single function (even with tree shaking!).</p>
38
8
  <p>Lodash is trying to cover each possible use case, even very rare while typical observed use case of lodash is basic
39
- methods used on basic data. As an example, let&#39;s take a <code>_.pick</code> method that simply returns an object, based on source
9
+ methods used on basic data. As an example, let's take a <code>_.pick</code> method that simply returns an object, based on source
40
10
  object, with just some properties copied. Easy, right? Few lines of code? Lodash makes that 114 imports!</p>
41
11
  <p><code>@ezez/utils</code> aims to:</p>
42
12
  <ul>
@@ -46,15 +16,7 @@ object, with just some properties copied. Easy, right? Few lines of code? Lodash
46
16
  <li>not being a &quot;polyfill&quot; (no <code>map</code>/<code>forEach</code> functions etc.),</li>
47
17
  <li>perform fast and have code size small.</li>
48
18
  </ul>
49
-
50
- <a href="#supported-methods" id="supported-methods" style="color: inherit; text-decoration: none;">
51
- <h2>Supported methods</h2>
52
- </a>
53
-
54
- <a href="#string-related" id="string-related" style="color: inherit; text-decoration: none;">
55
- <h3>String related</h3>
56
- </a>
57
- <ul>
19
+ <a id="md:supported-methods" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Supported methods<a href="#md:supported-methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="md:string-related" class="tsd-anchor"></a><h3 class="tsd-anchor-link">String related<a href="#md:string-related" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
58
20
  <li><code>addPrefix</code> - add prefix to a string if not already present</li>
59
21
  <li><code>addSuffix</code> - add suffix to a string if not already present</li>
60
22
  <li><code>capitalize</code> - capitalize a string, optionally lower casing the rest</li>
@@ -64,36 +26,24 @@ object, with just some properties copied. Easy, right? Few lines of code? Lodash
64
26
  <li><code>stripPrefix</code> - strip prefix from a string</li>
65
27
  <li><code>stripSuffix</code> - strip suffix from a string</li>
66
28
  </ul>
67
-
68
- <a href="#number-related" id="number-related" style="color: inherit; text-decoration: none;">
69
- <h3>Number related</h3>
70
- </a>
71
- <ul>
29
+ <a id="md:number-related" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Number related<a href="#md:number-related" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
72
30
  <li><code>cap</code> - cap a value between lower and upper bound</li>
73
31
  <li><code>round</code> - round a value to given precision</li>
74
32
  <li><code>scale</code> - scale given value from old range to new range</li>
75
33
  </ul>
76
-
77
- <a href="#array-related" id="array-related" style="color: inherit; text-decoration: none;">
78
- <h3>Array related</h3>
79
- </a>
80
- <ul>
34
+ <a id="md:array-related" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Array related<a href="#md:array-related" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
81
35
  <li><code>compareArrays</code> - compare two arrays</li>
82
36
  <li><code>ensureArray</code> - ensure that given value is an array</li>
83
37
  <li><code>insertSeparator</code> - insert a separator between every character in an array</li>
84
38
  <li><code>last</code> - get last element of an array</li>
85
- <li><code>match</code> - split your array into two groups - one that matches given predicate, and one that doesn&#39;t</li>
39
+ <li><code>match</code> - split your array into two groups - one that matches given predicate, and one that doesn't</li>
86
40
  <li><code>mostFrequent</code> - find most frequent value in an array</li>
87
41
  <li><code>pull</code> - remove values from an array (by mutating)</li>
88
42
  <li><code>remove</code> - remove values from an array (by mutating) using predicate function and return removed values</li>
89
43
  <li><code>sortBy</code> - sort an array by given property (create callback function for <code>Array.prototype.sort</code>)</li>
90
44
  <li><code>unique</code> - get unique values from an array</li>
91
45
  </ul>
92
-
93
- <a href="#object-related" id="object-related" style="color: inherit; text-decoration: none;">
94
- <h3>Object related</h3>
95
- </a>
96
- <ul>
46
+ <a id="md:object-related" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Object related<a href="#md:object-related" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
97
47
  <li><code>compareProps</code> - compare two objects and return list of different properties</li>
98
48
  <li><code>deserialize</code> - deserialize values serialized with <code>serialize</code></li>
99
49
  <li><code>isPlainObject</code> - check if given value is a plain object</li>
@@ -105,30 +55,18 @@ object, with just some properties copied. Easy, right? Few lines of code? Lodash
105
55
  <li><code>sortProps</code> - sort object properties by key</li>
106
56
  <li><code>serialize</code> - like JSON.stringify but any data type is allowed</li>
107
57
  </ul>
108
-
109
- <a href="#date-related" id="date-related" style="color: inherit; text-decoration: none;">
110
- <h3>Date related</h3>
111
- </a>
112
- <ul>
58
+ <a id="md:date-related" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Date related<a href="#md:date-related" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
113
59
  <li><code>ensureDate</code> - ensure that given value is a Date instance</li>
114
60
  <li><code>ensureTimestamp</code> - ensure that given value is a numeric timestamp</li>
115
61
  <li><code>formatDate</code> - format a date using a format string, syntax from PHP</li>
116
62
  </ul>
117
-
118
- <a href="#typedata-safety" id="typedata-safety" style="color: inherit; text-decoration: none;">
119
- <h3>Type/data safety</h3>
120
- </a>
121
- <ul>
63
+ <a id="md:typedata-safety" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Type/data safety<a href="#md:typedata-safety" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
122
64
  <li><code>coalesce</code> - return first non-nullish value</li>
123
65
  <li><code>ensureError</code> - ensure that given value is an error</li>
124
66
  <li><code>escapeRegExp</code> - escape a string to be used in a regular expression</li>
125
67
  <li><code>safe</code> - runs function and returns its result or default value if function throws an error</li>
126
68
  </ul>
127
-
128
- <a href="#flow-related" id="flow-related" style="color: inherit; text-decoration: none;">
129
- <h3>Flow related</h3>
130
- </a>
131
- <ul>
69
+ <a id="md:flow-related" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Flow related<a href="#md:flow-related" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
132
70
  <li><code>later</code> - create a promise you can resolve later, outside of Promise constructor</li>
133
71
  <li><code>mapAsync</code> - map an array asynchronously if sync version blocks your event loop for too long</li>
134
72
  <li><code>noop</code> - do nothing</li>
@@ -138,11 +76,7 @@ object, with just some properties copied. Easy, right? Few lines of code? Lodash
138
76
  <li><code>waitSync</code> - wait given amount of time (sync)</li>
139
77
  <li><code>waitFor</code> - wait for a condition to be true, checking every given amount of time</li>
140
78
  </ul>
141
-
142
- <a href="#various" id="various" style="color: inherit; text-decoration: none;">
143
- <h3>Various</h3>
144
- </a>
145
- <ul>
79
+ <a id="md:various" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Various<a href="#md:various" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
146
80
  <li><code>get</code> - extract a value from a deep object using specified path, optionally with a default value</li>
147
81
  <li><code>getMultiple</code> - same as above, but test multiple paths</li>
148
82
  <li><code>set</code> - set a value in a deep object using specified path</li>
@@ -153,133 +87,10 @@ object, with just some properties copied. Easy, right? Few lines of code? Lodash
153
87
  </ul>
154
88
  <p>Methods will be added as I need them. I am open for suggestions and PRs. See next heading for list of methods that I
155
89
  want to add.</p>
156
-
157
- <a href="#methods-to-be-supported" id="methods-to-be-supported" style="color: inherit; text-decoration: none;">
158
- <h2>Methods to be supported</h2>
159
- </a>
160
- <p>(TODO)</p>
90
+ <a id="md:methods-to-be-supported" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Methods to be supported<a href="#md:methods-to-be-supported" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>(TODO)</p>
161
91
  <ul>
162
92
  <li>debounce</li>
163
93
  </ul>
164
-
165
- <a href="#tested" id="tested" style="color: inherit; text-decoration: none;">
166
- <h2>Tested</h2>
167
- </a>
168
- <p>This library is fully unit tested and can be used on production. See License.</p>
169
-
170
- <a href="#license" id="license" style="color: inherit; text-decoration: none;">
171
- <h2>License</h2>
172
- </a>
173
- <p>MIT</p>
174
- </div></div>
175
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
176
- <div class="tsd-navigation settings">
177
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
178
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
179
- <div class="tsd-accordion-details">
180
- <div class="tsd-filter-visibility">
181
- <h4 class="uppercase">Member Visibility</h4><form>
182
- <ul id="tsd-filter-options">
183
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
184
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
185
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
186
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
187
- <div class="tsd-theme-toggle">
188
- <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
189
- <nav class="tsd-navigation primary">
190
- <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
191
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
192
- <div class="tsd-accordion-details">
193
- <ul>
194
- <li class="current selected"><a href="modules.html">@ezez/utils -<wbr/> v4.0.0</a>
195
- <ul>
196
- <li class="pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/Introduction.html">Introduction</a></li>
197
- <li class="pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/CHANGELOG.html">Changelog</a></li></ul></li></ul></div></details></nav>
198
- <nav class="tsd-navigation secondary menu-sticky">
199
- <ul>
200
- <li class="tsd-kind-interface"><a href="interfaces/ComparePropsOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>Compare<wbr/>Props<wbr/>Options</a></li>
201
- <li class="tsd-kind-interface"><a href="interfaces/GetMultipleSource.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Get<wbr/>Multiple<wbr/>Source</a></li>
202
- <li class="tsd-kind-interface"><a href="interfaces/GetSource.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Get<wbr/>Source</a></li>
203
- <li class="tsd-kind-interface"><a href="interfaces/IsNumericStringOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Is<wbr/>Numeric<wbr/>String<wbr/>Options</a></li>
204
- <li class="tsd-kind-interface"><a href="interfaces/OccurencesOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Occurences<wbr/>Options</a></li>
205
- <li class="tsd-kind-interface"><a href="interfaces/SetImmutableSource.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Set<wbr/>Immutable<wbr/>Source</a></li>
206
- <li class="tsd-kind-interface"><a href="interfaces/SetSource.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Set<wbr/>Source</a></li>
207
- <li class="tsd-kind-interface"><a href="interfaces/ThrottleOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Throttle<wbr/>Options</a></li>
208
- <li class="tsd-kind-interface"><a href="interfaces/ThrottledFunctionExtras.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Throttled<wbr/>Function<wbr/>Extras</a></li>
209
- <li class="tsd-kind-type-alias"><a href="types/CustomDeserializers.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>Custom<wbr/>Deserializers</a></li>
210
- <li class="tsd-kind-type-alias"><a href="types/CustomSerializers.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Custom<wbr/>Serializers</a></li>
211
- <li class="tsd-kind-type-alias"><a href="types/Later.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Later</a></li>
212
- <li class="tsd-kind-type-alias"><a href="types/MapValuesFn.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Map<wbr/>Values<wbr/>Fn</a></li>
213
- <li class="tsd-kind-type-alias"><a href="types/MatchCallback.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Match<wbr/>Callback</a></li>
214
- <li class="tsd-kind-type-alias"><a href="types/SeqEarlyBreaker.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Seq<wbr/>Early<wbr/>Breaker</a></li>
215
- <li class="tsd-kind-type-alias"><a href="types/SeqFn.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Seq<wbr/>Fn</a></li>
216
- <li class="tsd-kind-type-alias"><a href="types/SeqFunctions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Seq<wbr/>Functions</a></li>
217
- <li class="tsd-kind-type-alias"><a href="types/SetImmutablePath.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Set<wbr/>Immutable<wbr/>Path</a></li>
218
- <li class="tsd-kind-type-alias"><a href="types/ThrottledFunction.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Throttled<wbr/>Function</a></li>
219
- <li class="tsd-kind-variable"><a href="variables/mapValuesUNSET.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>map<wbr/>ValuesUNSET</a></li>
220
- <li class="tsd-kind-variable"><a href="variables/mergeUNSET.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>mergeUNSET</a></li>
221
- <li class="tsd-kind-function"><a href="functions/cap.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>cap</a></li>
222
- <li class="tsd-kind-function"><a href="functions/capitalize.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>capitalize</a></li>
223
- <li class="tsd-kind-function"><a href="functions/coalesce.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>coalesce</a></li>
224
- <li class="tsd-kind-function"><a href="functions/compareArrays.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>compare<wbr/>Arrays</a></li>
225
- <li class="tsd-kind-function"><a href="functions/compareProps.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>compare<wbr/>Props</a></li>
226
- <li class="tsd-kind-function"><a href="functions/deserialize.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>deserialize</a></li>
227
- <li class="tsd-kind-function"><a href="functions/ensureArray.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>ensure<wbr/>Array</a></li>
228
- <li class="tsd-kind-function"><a href="functions/ensureDate.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>ensure<wbr/>Date</a></li>
229
- <li class="tsd-kind-function"><a href="functions/ensureError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>ensure<wbr/>Error</a></li>
230
- <li class="tsd-kind-function"><a href="functions/ensurePrefix.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>ensure<wbr/>Prefix</a></li>
231
- <li class="tsd-kind-function"><a href="functions/ensureSuffix.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>ensure<wbr/>Suffix</a></li>
232
- <li class="tsd-kind-function"><a href="functions/ensureTimestamp.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>ensure<wbr/>Timestamp</a></li>
233
- <li class="tsd-kind-function"><a href="functions/escapeRegExp.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>escape<wbr/>Reg<wbr/>Exp</a></li>
234
- <li class="tsd-kind-function"><a href="functions/formatDate.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>format<wbr/>Date</a></li>
235
- <li class="tsd-kind-function"><a href="functions/get.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>get</a></li>
236
- <li class="tsd-kind-function"><a href="functions/getMultiple.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>get<wbr/>Multiple</a></li>
237
- <li class="tsd-kind-function"><a href="functions/insertSeparator.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>insert<wbr/>Separator</a></li>
238
- <li class="tsd-kind-function"><a href="functions/isEmpty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>is<wbr/>Empty</a></li>
239
- <li class="tsd-kind-function"><a href="functions/isNumericString.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>is<wbr/>Numeric<wbr/>String</a></li>
240
- <li class="tsd-kind-function"><a href="functions/isPlainObject.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>is<wbr/>Plain<wbr/>Object</a></li>
241
- <li class="tsd-kind-function"><a href="functions/last.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>last</a></li>
242
- <li class="tsd-kind-function"><a href="functions/later-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>later</a></li>
243
- <li class="tsd-kind-function"><a href="functions/mapAsync.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>map<wbr/>Async</a></li>
244
- <li class="tsd-kind-function"><a href="functions/mapValues.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>map<wbr/>Values</a></li>
245
- <li class="tsd-kind-function"><a href="functions/match.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>match</a></li>
246
- <li class="tsd-kind-function"><a href="functions/merge.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>merge</a></li>
247
- <li class="tsd-kind-function"><a href="functions/mostFrequent.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>most<wbr/>Frequent</a></li>
248
- <li class="tsd-kind-function"><a href="functions/noop.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>noop</a></li>
249
- <li class="tsd-kind-function"><a href="functions/occurrences.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>occurrences</a></li>
250
- <li class="tsd-kind-function"><a href="functions/omit.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>omit</a></li>
251
- <li class="tsd-kind-function"><a href="functions/pick.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>pick</a></li>
252
- <li class="tsd-kind-function"><a href="functions/pull.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>pull</a></li>
253
- <li class="tsd-kind-function"><a href="functions/remove.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>remove</a></li>
254
- <li class="tsd-kind-function"><a href="functions/removeCommonProperties.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>remove<wbr/>Common<wbr/>Properties</a></li>
255
- <li class="tsd-kind-function"><a href="functions/replace.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>replace</a></li>
256
- <li class="tsd-kind-function"><a href="functions/replaceDeep.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>replace<wbr/>Deep</a></li>
257
- <li class="tsd-kind-function"><a href="functions/rethrow.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>rethrow</a></li>
258
- <li class="tsd-kind-function"><a href="functions/round.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>round</a></li>
259
- <li class="tsd-kind-function"><a href="functions/safe.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>safe</a></li>
260
- <li class="tsd-kind-function"><a href="functions/sample.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>sample</a></li>
261
- <li class="tsd-kind-function"><a href="functions/samples.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>samples</a></li>
262
- <li class="tsd-kind-function"><a href="functions/scale.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>scale</a></li>
263
- <li class="tsd-kind-function"><a href="functions/seq.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>seq</a></li>
264
- <li class="tsd-kind-function"><a href="functions/seqEarlyBreak.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>seq<wbr/>Early<wbr/>Break</a></li>
265
- <li class="tsd-kind-function"><a href="functions/serialize.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>serialize</a></li>
266
- <li class="tsd-kind-function"><a href="functions/set.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>set</a></li>
267
- <li class="tsd-kind-function"><a href="functions/setImmutable.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>set<wbr/>Immutable</a></li>
268
- <li class="tsd-kind-function"><a href="functions/shuffle.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>shuffle</a></li>
269
- <li class="tsd-kind-function"><a href="functions/sortBy.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>sort<wbr/>By</a></li>
270
- <li class="tsd-kind-function"><a href="functions/sortProps.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>sort<wbr/>Props</a></li>
271
- <li class="tsd-kind-function"><a href="functions/stripPrefix.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>strip<wbr/>Prefix</a></li>
272
- <li class="tsd-kind-function"><a href="functions/stripSuffix.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>strip<wbr/>Suffix</a></li>
273
- <li class="tsd-kind-function"><a href="functions/throttle.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>throttle</a></li>
274
- <li class="tsd-kind-function"><a href="functions/toggle.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>toggle</a></li>
275
- <li class="tsd-kind-function"><a href="functions/trim.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>trim</a></li>
276
- <li class="tsd-kind-function"><a href="functions/trimEnd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>trim<wbr/>End</a></li>
277
- <li class="tsd-kind-function"><a href="functions/trimStart.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>trim<wbr/>Start</a></li>
278
- <li class="tsd-kind-function"><a href="functions/truthy.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>truthy</a></li>
279
- <li class="tsd-kind-function"><a href="functions/unique.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>unique</a></li>
280
- <li class="tsd-kind-function"><a href="functions/wait.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>wait</a></li>
281
- <li class="tsd-kind-function"><a href="functions/waitFor.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>wait<wbr/>For</a></li>
282
- <li class="tsd-kind-function"><a href="functions/waitSync.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>wait<wbr/>Sync</a></li></ul></nav></div></div>
283
- <div class="container tsd-generator">
284
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
285
- <div class="overlay"></div><script src="assets/main.js"></script></body></html>
94
+ <a id="md:tested" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Tested<a href="#md:tested" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>This library is fully unit tested and can be used on production. See License.</p>
95
+ <a id="md:license" class="tsd-anchor"></a><h2 class="tsd-anchor-link">License<a href="#md:license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>MIT</p>
96
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:ezezutils"><span>@ezez/utils</span></a><ul><li><a href="#md:documentation"><span>Documentation</span></a></li><li><a href="#md:installing"><span>Installing</span></a></li><li><a href="#md:motivation"><span>Motivation</span></a></li><li><a href="#md:supported-methods"><span>Supported methods</span></a></li><li><ul><li><a href="#md:string-related"><span>String related</span></a></li><li><a href="#md:number-related"><span>Number related</span></a></li><li><a href="#md:array-related"><span>Array related</span></a></li><li><a href="#md:object-related"><span>Object related</span></a></li><li><a href="#md:date-related"><span>Date related</span></a></li><li><a href="#md:typedata-safety"><span>Type/data safety</span></a></li><li><a href="#md:flow-related"><span>Flow related</span></a></li><li><a href="#md:various"><span>Various</span></a></li></ul></li><li><a href="#md:methods-to-be-supported"><span>Methods to be supported</span></a></li><li><a href="#md:tested"><span>Tested</span></a></li><li><a href="#md:license"><span>License</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@ezez/utils - v4.1.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/interfaces/index.ComparePropsOptions.html ADDED
@@ -0,0 +1,5 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ComparePropsOptions | @ezez/utils - v4.1.0</title><meta name="description" content="Documentation for @ezez/utils"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@ezez/utils - v4.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@ezez/utils</a></li><li><a href="../modules/index.html">index</a></li><li><a href="index.ComparePropsOptions.html">ComparePropsOptions</a></li></ul><h1>Interface ComparePropsOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Options for <code>compareProps</code> function.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ComparePropsOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="index.ComparePropsOptions.html#missingEqualsUndefined">missingEqualsUndefined</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dzek69/bottom-line/blob/e3307393551770c659e984ef501ad00f2839ca27/src/compareProps.ts#L6">compareProps.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="index.ComparePropsOptions.html#missingEqualsUndefined" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>missing<wbr/>Equals<wbr/>Undefined?</span></a>
3
+ </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="missingEqualsUndefined" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>missing<wbr/>Equals<wbr/>Undefined</span><a href="#missingEqualsUndefined" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">missing<wbr/>Equals<wbr/>Undefined</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If <code>true</code>, missing properties in the first object will be considered as equal to explicit <code>undefined</code> properties
4
+ in the second.</p>
5
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dzek69/bottom-line/blob/e3307393551770c659e984ef501ad00f2839ca27/src/compareProps.ts#L11">compareProps.ts:11</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#missingEqualsUndefined" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>missing<wbr/>Equals<wbr/>Undefined</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@ezez/utils - v4.1.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/interfaces/index.GetMultipleSource.html ADDED
@@ -0,0 +1,3 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GetMultipleSource | @ezez/utils - v4.1.0</title><meta name="description" content="Documentation for @ezez/utils"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@ezez/utils - v4.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@ezez/utils</a></li><li><a href="../modules/index.html">index</a></li><li><a href="index.GetMultipleSource.html">GetMultipleSource</a></li></ul><h1>Interface GetMultipleSource</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Source object to search in.</p>
2
+ </div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="../functions/index.getMultiple.html">getMultiple</a>.</p>
3
+ </div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">GetMultipleSource</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4 class="tsd-before-signature">Indexable</h4><div class="tsd-signature"><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">unknown</span></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dzek69/bottom-line/blob/e3307393551770c659e984ef501ad00f2839ca27/src/getMultiple.ts#L8">getMultiple.ts:8</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@ezez/utils - v4.1.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/interfaces/index.GetSource.html ADDED
@@ -0,0 +1,3 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GetSource | @ezez/utils - v4.1.0</title><meta name="description" content="Documentation for @ezez/utils"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@ezez/utils - v4.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@ezez/utils</a></li><li><a href="../modules/index.html">index</a></li><li><a href="index.GetSource.html">GetSource</a></li></ul><h1>Interface GetSource</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Source object to search in.</p>
2
+ </div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="../functions/index.get.html">get</a>.</p>
3
+ </div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">GetSource</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4 class="tsd-before-signature">Indexable</h4><div class="tsd-signature"><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">unknown</span></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dzek69/bottom-line/blob/e3307393551770c659e984ef501ad00f2839ca27/src/get.ts#L6">get.ts:6</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@ezez/utils - v4.1.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>