@design-edito/tools 0.4.23 → 0.5.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 (490) hide show
  1. package/agnostic/arrays/find-duplicates/index.d.ts +1 -1
  2. package/agnostic/arrays/find-duplicates/index.js +3 -2
  3. package/agnostic/arrays/is-array-of/index.d.ts +1 -1
  4. package/agnostic/arrays/is-array-of/index.js +3 -1
  5. package/agnostic/arrays/make/index.d.ts +1 -1
  6. package/agnostic/arrays/random-pick/index.js +2 -1
  7. package/agnostic/arrays/shuffle/index.js +1 -1
  8. package/agnostic/booleans/is-falsy/index.d.ts +3 -3
  9. package/agnostic/booleans/is-falsy/index.js +2 -3
  10. package/agnostic/colors/channels/index.d.ts +16 -16
  11. package/agnostic/colors/channels/index.js +15 -15
  12. package/agnostic/colors/contrast/index.d.ts +6 -6
  13. package/agnostic/colors/contrast/index.js +6 -8
  14. package/agnostic/colors/contrast/index.test.js +1 -1
  15. package/agnostic/colors/convert/index.d.ts +43 -43
  16. package/agnostic/colors/convert/index.js +60 -55
  17. package/agnostic/colors/distance/index.d.ts +5 -5
  18. package/agnostic/colors/distance/index.js +5 -4
  19. package/agnostic/colors/grayscale/index.d.ts +3 -3
  20. package/agnostic/colors/grayscale/index.js +3 -3
  21. package/agnostic/colors/index.d.ts +3 -3
  22. package/agnostic/colors/index.js +3 -3
  23. package/agnostic/colors/invert/index.d.ts +4 -4
  24. package/agnostic/colors/invert/index.js +3 -3
  25. package/agnostic/colors/lerp/index.d.ts +6 -7
  26. package/agnostic/colors/lerp/index.js +5 -6
  27. package/agnostic/colors/luminance/index.d.ts +4 -4
  28. package/agnostic/colors/luminance/index.js +3 -3
  29. package/agnostic/colors/palette/index.d.ts +3 -3
  30. package/agnostic/colors/palette/index.js +4 -3
  31. package/agnostic/colors/rotate/index.d.ts +4 -4
  32. package/agnostic/colors/rotate/index.js +4 -4
  33. package/agnostic/colors/tidy/index.d.ts +2 -2
  34. package/agnostic/colors/tidy/index.js +2 -2
  35. package/agnostic/colors/typechecks/index.d.ts +21 -21
  36. package/agnostic/colors/typechecks/index.js +22 -21
  37. package/agnostic/colors/types.d.ts +33 -33
  38. package/agnostic/css/bem/index.d.ts +11 -11
  39. package/agnostic/css/bem/index.js +9 -8
  40. package/agnostic/css/clss/index.d.ts +1 -1
  41. package/agnostic/css/clss/index.js +1 -1
  42. package/agnostic/css/index.d.ts +1 -1
  43. package/agnostic/css/index.js +1 -1
  44. package/agnostic/css/is-valid-css-class-name/index.d.ts +2 -2
  45. package/agnostic/css/is-valid-css-class-name/index.js +3 -3
  46. package/agnostic/css/scale/index.d.ts +18 -18
  47. package/agnostic/css/scale/index.js +18 -18
  48. package/agnostic/css/styles-set/index.d.ts +1 -1
  49. package/agnostic/css/styles-set/index.js +0 -2
  50. package/agnostic/errors/register/index.d.ts +1 -1
  51. package/agnostic/errors/register/index.js +3 -0
  52. package/agnostic/errors/unknown-to-string/index.d.ts +2 -2
  53. package/agnostic/errors/unknown-to-string/index.js +2 -3
  54. package/agnostic/html/deep-select/index.d.ts +3 -3
  55. package/agnostic/html/deep-select/index.js +11 -7
  56. package/agnostic/html/get-node-ancestors/index.d.ts +3 -3
  57. package/agnostic/html/get-node-ancestors/index.js +3 -3
  58. package/agnostic/html/get-position-inside-parent/index.d.ts +2 -2
  59. package/agnostic/html/get-position-inside-parent/index.js +2 -2
  60. package/agnostic/html/hyper-json/cast/index.d.ts +1 -1
  61. package/agnostic/html/hyper-json/cast/index.js +6 -5
  62. package/agnostic/html/hyper-json/method/index.d.ts +2 -2
  63. package/agnostic/html/hyper-json/serialize/index.d.ts +1 -1
  64. package/agnostic/html/hyper-json/serialize/index.js +9 -5
  65. package/agnostic/html/hyper-json/smart-tags/coalesced/addclass/index.js +1 -0
  66. package/agnostic/html/hyper-json/smart-tags/coalesced/and/index.d.ts +1 -1
  67. package/agnostic/html/hyper-json/smart-tags/coalesced/append/index.d.ts +1 -1
  68. package/agnostic/html/hyper-json/smart-tags/coalesced/append/index.js +1 -0
  69. package/agnostic/html/hyper-json/smart-tags/coalesced/at/index.d.ts +1 -1
  70. package/agnostic/html/hyper-json/smart-tags/coalesced/at/index.js +1 -0
  71. package/agnostic/html/hyper-json/smart-tags/coalesced/call/index.d.ts +1 -1
  72. package/agnostic/html/hyper-json/smart-tags/coalesced/call/index.js +1 -1
  73. package/agnostic/html/hyper-json/smart-tags/coalesced/clone/index.d.ts +1 -1
  74. package/agnostic/html/hyper-json/smart-tags/coalesced/deleteproperties/index.d.ts +1 -1
  75. package/agnostic/html/hyper-json/smart-tags/coalesced/deleteproperties/index.js +0 -1
  76. package/agnostic/html/hyper-json/smart-tags/coalesced/equals/index.d.ts +1 -1
  77. package/agnostic/html/hyper-json/smart-tags/coalesced/getattribute/index.js +1 -0
  78. package/agnostic/html/hyper-json/smart-tags/coalesced/getproperties/index.d.ts +1 -1
  79. package/agnostic/html/hyper-json/smart-tags/coalesced/getproperty/index.d.ts +1 -1
  80. package/agnostic/html/hyper-json/smart-tags/coalesced/getproperty/index.js +1 -2
  81. package/agnostic/html/hyper-json/smart-tags/coalesced/hjparse/index.d.ts +1 -1
  82. package/agnostic/html/hyper-json/smart-tags/coalesced/hjstringify/index.d.ts +1 -1
  83. package/agnostic/html/hyper-json/smart-tags/coalesced/hjstringify/index.js +4 -0
  84. package/agnostic/html/hyper-json/smart-tags/coalesced/if/index.d.ts +1 -1
  85. package/agnostic/html/hyper-json/smart-tags/coalesced/if/index.js +1 -0
  86. package/agnostic/html/hyper-json/smart-tags/coalesced/index.d.ts +6 -6
  87. package/agnostic/html/hyper-json/smart-tags/coalesced/index.js +6 -6
  88. package/agnostic/html/hyper-json/smart-tags/coalesced/initialize/index.d.ts +1 -1
  89. package/agnostic/html/hyper-json/smart-tags/coalesced/initialize/index.js +1 -0
  90. package/agnostic/html/hyper-json/smart-tags/coalesced/join/index.d.ts +1 -1
  91. package/agnostic/html/hyper-json/smart-tags/coalesced/length/index.d.ts +1 -1
  92. package/agnostic/html/hyper-json/smart-tags/coalesced/map/index.d.ts +1 -1
  93. package/agnostic/html/hyper-json/smart-tags/coalesced/or/index.d.ts +1 -1
  94. package/agnostic/html/hyper-json/smart-tags/coalesced/pickrandom/index.d.ts +1 -1
  95. package/agnostic/html/hyper-json/smart-tags/coalesced/populate/index.d.ts +1 -1
  96. package/agnostic/html/hyper-json/smart-tags/coalesced/populate/index.js +1 -0
  97. package/agnostic/html/hyper-json/smart-tags/coalesced/print/index.d.ts +1 -1
  98. package/agnostic/html/hyper-json/smart-tags/coalesced/print/index.js +2 -0
  99. package/agnostic/html/hyper-json/smart-tags/coalesced/push/index.d.ts +1 -1
  100. package/agnostic/html/hyper-json/smart-tags/coalesced/pusheach/index.d.ts +1 -1
  101. package/agnostic/html/hyper-json/smart-tags/coalesced/pusheach/index.js +1 -0
  102. package/agnostic/html/hyper-json/smart-tags/coalesced/recordtoarray/index.d.ts +1 -1
  103. package/agnostic/html/hyper-json/smart-tags/coalesced/removeattribute/index.js +3 -0
  104. package/agnostic/html/hyper-json/smart-tags/coalesced/removeclass/index.js +1 -0
  105. package/agnostic/html/hyper-json/smart-tags/coalesced/renameproperty/index.d.ts +1 -1
  106. package/agnostic/html/hyper-json/smart-tags/coalesced/renameproperty/index.js +1 -0
  107. package/agnostic/html/hyper-json/smart-tags/coalesced/replace/index.d.ts +1 -1
  108. package/agnostic/html/hyper-json/smart-tags/coalesced/replace/index.js +1 -0
  109. package/agnostic/html/hyper-json/smart-tags/coalesced/select/index.js +1 -0
  110. package/agnostic/html/hyper-json/smart-tags/coalesced/set/index.d.ts +1 -1
  111. package/agnostic/html/hyper-json/smart-tags/coalesced/set/index.js +1 -0
  112. package/agnostic/html/hyper-json/smart-tags/coalesced/setattribute/index.js +3 -0
  113. package/agnostic/html/hyper-json/smart-tags/coalesced/setproperty/index.d.ts +1 -1
  114. package/agnostic/html/hyper-json/smart-tags/coalesced/setproperty/index.js +4 -2
  115. package/agnostic/html/hyper-json/smart-tags/coalesced/sorton/index.d.ts +1 -1
  116. package/agnostic/html/hyper-json/smart-tags/coalesced/sorton/index.js +5 -0
  117. package/agnostic/html/hyper-json/smart-tags/coalesced/spread/index.d.ts +1 -1
  118. package/agnostic/html/hyper-json/smart-tags/coalesced/spread/index.js +1 -0
  119. package/agnostic/html/hyper-json/smart-tags/coalesced/toarray/index.d.ts +1 -1
  120. package/agnostic/html/hyper-json/smart-tags/coalesced/toboolean/index.d.ts +1 -1
  121. package/agnostic/html/hyper-json/smart-tags/coalesced/toelement/index.d.ts +1 -1
  122. package/agnostic/html/hyper-json/smart-tags/coalesced/toggleclass/index.js +3 -2
  123. package/agnostic/html/hyper-json/smart-tags/coalesced/tonodelist/index.d.ts +1 -1
  124. package/agnostic/html/hyper-json/smart-tags/coalesced/tonull/index.d.ts +1 -1
  125. package/agnostic/html/hyper-json/smart-tags/coalesced/tonumber/index.d.ts +1 -1
  126. package/agnostic/html/hyper-json/smart-tags/coalesced/torecord/index.d.ts +1 -1
  127. package/agnostic/html/hyper-json/smart-tags/coalesced/toref/index.d.ts +1 -1
  128. package/agnostic/html/hyper-json/smart-tags/coalesced/tostring/index.d.ts +1 -1
  129. package/agnostic/html/hyper-json/smart-tags/coalesced/totext/index.d.ts +1 -1
  130. package/agnostic/html/hyper-json/smart-tags/coalesced/transformselected/index.d.ts +1 -1
  131. package/agnostic/html/hyper-json/smart-tags/coalesced/trim/index.js +1 -1
  132. package/agnostic/html/hyper-json/smart-tags/index.d.ts +1 -1
  133. package/agnostic/html/hyper-json/smart-tags/isolated/any/index.d.ts +1 -1
  134. package/agnostic/html/hyper-json/smart-tags/isolated/array/index.d.ts +1 -1
  135. package/agnostic/html/hyper-json/smart-tags/isolated/get/index.d.ts +1 -1
  136. package/agnostic/html/hyper-json/smart-tags/isolated/guess/index.d.ts +1 -1
  137. package/agnostic/html/hyper-json/smart-tags/isolated/guess/index.js +3 -1
  138. package/agnostic/html/hyper-json/smart-tags/isolated/index.d.ts +2 -2
  139. package/agnostic/html/hyper-json/smart-tags/isolated/index.js +2 -2
  140. package/agnostic/html/hyper-json/smart-tags/isolated/nodelist/index.d.ts +1 -1
  141. package/agnostic/html/hyper-json/smart-tags/isolated/nodelist/index.js +1 -0
  142. package/agnostic/html/hyper-json/smart-tags/isolated/null/index.d.ts +1 -1
  143. package/agnostic/html/hyper-json/smart-tags/isolated/record/index.d.ts +1 -1
  144. package/agnostic/html/hyper-json/smart-tags/isolated/ref/index.d.ts +1 -1
  145. package/agnostic/html/hyper-json/smart-tags/isolated/ref/index.js +3 -1
  146. package/agnostic/html/hyper-json/smart-tags/isolated/text/index.js +2 -2
  147. package/agnostic/html/hyper-json/transformer/index.d.ts +5 -5
  148. package/agnostic/html/hyper-json/tree/index.d.ts +1 -1
  149. package/agnostic/html/hyper-json/tree/index.js +14 -8
  150. package/agnostic/html/hyper-json/types/index.d.ts +11 -11
  151. package/agnostic/html/hyper-json/utils/index.d.ts +3 -3
  152. package/agnostic/html/hyper-json/utils/index.js +8 -3
  153. package/agnostic/html/index.d.ts +4 -4
  154. package/agnostic/html/index.js +4 -4
  155. package/agnostic/html/insert-node/index.d.ts +4 -4
  156. package/agnostic/html/insert-node/index.js +4 -4
  157. package/agnostic/html/replace-in-element/index.d.ts +3 -3
  158. package/agnostic/html/replace-in-element/index.js +4 -4
  159. package/agnostic/html/selector-to-element/index.d.ts +2 -2
  160. package/agnostic/html/selector-to-element/index.js +11 -11
  161. package/agnostic/html/string-to-nodes/index.d.ts +3 -3
  162. package/agnostic/html/string-to-nodes/index.js +3 -3
  163. package/agnostic/html/watch-selection/index.d.ts +4 -5
  164. package/agnostic/html/watch-selection/index.js +5 -6
  165. package/agnostic/misc/assert/index.js +3 -1
  166. package/agnostic/misc/cast/index.d.ts +16 -16
  167. package/agnostic/misc/cast/index.js +18 -18
  168. package/agnostic/misc/connection/index.d.ts +5 -5
  169. package/agnostic/misc/connection/index.js +4 -2
  170. package/agnostic/misc/crawler/index.d.ts +18 -18
  171. package/agnostic/misc/crawler/index.js +10 -9
  172. package/agnostic/misc/crawler/index.test.js +2 -2
  173. package/agnostic/misc/crossenv/detect-runtime/index.d.ts +1 -1
  174. package/agnostic/misc/crossenv/detect-runtime/index.js +10 -11
  175. package/agnostic/misc/crossenv/window/index.d.ts +6 -6
  176. package/agnostic/misc/crossenv/window/index.js +6 -5
  177. package/agnostic/misc/data-size/index.js +2 -0
  178. package/agnostic/misc/index.d.ts +2 -2
  179. package/agnostic/misc/index.js +2 -2
  180. package/agnostic/misc/is-constructor-function/index.d.ts +2 -2
  181. package/agnostic/misc/is-constructor-function/index.js +3 -2
  182. package/agnostic/misc/is-constructor-function/index.test.js +2 -2
  183. package/agnostic/misc/is-nullish/index.d.ts +5 -5
  184. package/agnostic/misc/is-nullish/index.js +5 -4
  185. package/agnostic/misc/logs/index.d.ts +1 -1
  186. package/agnostic/misc/logs/index.js +1 -1
  187. package/agnostic/misc/logs/logger/index.js +2 -2
  188. package/agnostic/misc/lorem-ipsum/index.js +4 -4
  189. package/agnostic/misc/normalize-extension/index.d.ts +3 -3
  190. package/agnostic/misc/normalize-extension/index.js +4 -4
  191. package/agnostic/misc/outcome/index.d.ts +14 -14
  192. package/agnostic/misc/outcome/index.js +6 -4
  193. package/agnostic/numbers/absolute-modulo/index.d.ts +3 -3
  194. package/agnostic/numbers/absolute-modulo/index.js +3 -3
  195. package/agnostic/numbers/approximate-rational/index.d.ts +6 -6
  196. package/agnostic/numbers/approximate-rational/index.js +9 -9
  197. package/agnostic/numbers/clamp/index.d.ts +4 -4
  198. package/agnostic/numbers/clamp/index.js +4 -4
  199. package/agnostic/numbers/geometric-progressions/index.d.ts +5 -5
  200. package/agnostic/numbers/geometric-progressions/index.js +7 -5
  201. package/agnostic/numbers/geometric-progressions/index.test.js +2 -2
  202. package/agnostic/numbers/index.d.ts +1 -1
  203. package/agnostic/numbers/index.js +1 -1
  204. package/agnostic/numbers/interpolate/index.d.ts +8 -8
  205. package/agnostic/numbers/interpolate/index.js +8 -8
  206. package/agnostic/numbers/round/index.d.ts +9 -9
  207. package/agnostic/numbers/round/index.js +9 -9
  208. package/agnostic/objects/deep-get-property/index.d.ts +4 -4
  209. package/agnostic/objects/deep-get-property/index.js +3 -3
  210. package/agnostic/objects/enums/is-in-enum/index.d.ts +3 -3
  211. package/agnostic/objects/enums/is-in-enum/index.js +3 -3
  212. package/agnostic/objects/flatten-getters/index.d.ts +2 -2
  213. package/agnostic/objects/flatten-getters/index.js +3 -2
  214. package/agnostic/objects/index.d.ts +2 -2
  215. package/agnostic/objects/index.js +2 -2
  216. package/agnostic/objects/is-object/index.d.ts +4 -4
  217. package/agnostic/objects/is-object/index.js +4 -4
  218. package/agnostic/objects/is-record/index.d.ts +2 -2
  219. package/agnostic/objects/is-record/index.js +2 -2
  220. package/agnostic/objects/record-format/index.d.ts +9 -9
  221. package/agnostic/objects/record-format/index.js +8 -3
  222. package/agnostic/objects/record-map/index.d.ts +4 -4
  223. package/agnostic/objects/record-map/index.js +5 -3
  224. package/agnostic/objects/sort-keys/index.d.ts +3 -3
  225. package/agnostic/objects/sort-keys/index.js +4 -3
  226. package/agnostic/objects/validation/index.d.ts +3 -3
  227. package/agnostic/objects/validation/index.js +4 -3
  228. package/agnostic/optim/memoize/index.d.ts +2 -2
  229. package/agnostic/optim/memoize/index.js +4 -2
  230. package/agnostic/optim/throttle-debounce/index.d.ts +2 -2
  231. package/agnostic/optim/throttle-debounce/index.js +7 -6
  232. package/agnostic/optim/throttle-debounce/types.d.ts +2 -1
  233. package/agnostic/random/random/index.d.ts +7 -8
  234. package/agnostic/random/random/index.js +3 -3
  235. package/agnostic/random/uuid/index.d.ts +6 -6
  236. package/agnostic/random/uuid/index.js +6 -6
  237. package/agnostic/regexps/index.d.ts +30 -60
  238. package/agnostic/regexps/index.js +27 -26
  239. package/agnostic/sanitization/file-name/index.d.ts +3 -3
  240. package/agnostic/sanitization/file-name/index.js +10 -10
  241. package/agnostic/sanitization/html/index.d.ts +6 -6
  242. package/agnostic/sanitization/html/index.js +9 -6
  243. package/agnostic/sanitization/index.d.ts +1 -1
  244. package/agnostic/sanitization/index.js +1 -1
  245. package/agnostic/sanitization/path/index.d.ts +2 -2
  246. package/agnostic/sanitization/path/index.js +2 -2
  247. package/agnostic/sanitization/user-input/index.js +1 -0
  248. package/agnostic/strings/char-codes/index.js +2 -6
  249. package/agnostic/strings/index.d.ts +1 -1
  250. package/agnostic/strings/index.js +1 -1
  251. package/agnostic/strings/normalize-indent/index.js +2 -2
  252. package/agnostic/strings/parse-table/index.d.ts +13 -13
  253. package/agnostic/strings/parse-table/index.js +31 -16
  254. package/agnostic/strings/replace-all/index.d.ts +1 -1
  255. package/agnostic/strings/replace-all/index.js +1 -0
  256. package/agnostic/strings/to-alphanum/index.js +2 -2
  257. package/agnostic/strings/trim/index.js +2 -2
  258. package/agnostic/time/dates/format-date/index.js +3 -1
  259. package/agnostic/time/dates/index.d.ts +1 -0
  260. package/agnostic/time/dates/index.js +1 -0
  261. package/agnostic/time/dates/to-french-republican/index.d.ts +16 -0
  262. package/agnostic/time/dates/to-french-republican/index.js +82 -0
  263. package/agnostic/time/dates/to-french-republican/index.test.d.ts +1 -0
  264. package/agnostic/time/dates/to-french-republican/index.test.js +112 -0
  265. package/agnostic/time/dates/to-french-republican/types.d.ts +91 -0
  266. package/agnostic/time/dates/to-french-republican/types.js +47 -0
  267. package/agnostic/time/dates/to-french-republican/utils.d.ts +32 -0
  268. package/agnostic/time/dates/to-french-republican/utils.js +155 -0
  269. package/agnostic/time/duration/index.js +2 -0
  270. package/agnostic/time/index.d.ts +2 -2
  271. package/agnostic/time/index.js +2 -2
  272. package/agnostic/time/timeout/index.js +9 -9
  273. package/agnostic/time/transitions/index.js +8 -7
  274. package/components/BeforeAfter/index.controlled.js +1 -0
  275. package/components/BeforeAfter/index.js +4 -0
  276. package/components/Button/index.d.ts +1 -1
  277. package/components/Clippable/index.js +1 -0
  278. package/components/Drawer/index.js +1 -1
  279. package/components/Gallery/index.js +2 -1
  280. package/components/Gallery/utils.js +5 -1
  281. package/components/Iframe/index.js +3 -0
  282. package/components/Image/index.js +2 -0
  283. package/components/Input/index.controlled.js +3 -2
  284. package/components/IntersectionObserver/index.js +5 -2
  285. package/components/JsonEditor/index.js +1 -1
  286. package/components/Overlayer/index.d.ts +1 -1
  287. package/components/ScrollListener/utils.d.ts +29 -0
  288. package/components/Select/index.controlled.js +3 -2
  289. package/components/Sequencer/index.controlled.js +1 -1
  290. package/components/Subtitles/index.js +3 -1
  291. package/components/Subtitles/types.d.ts +14 -0
  292. package/components/Subtitles/utils.d.ts +19 -15
  293. package/components/Subtitles/utils.js +29 -24
  294. package/components/Textarea/index.controlled.js +3 -2
  295. package/components/UIModule/index.js +3 -1
  296. package/components/Video/index.controlled.d.ts +1 -1
  297. package/components/Video/index.controlled.js +11 -10
  298. package/components/Video/index.js +27 -20
  299. package/components/Video/utils.d.ts +1 -1
  300. package/components/Video/utils.js +11 -2
  301. package/components/index.d.ts +2 -2
  302. package/components/index.js +2 -2
  303. package/components/utils/types.d.ts +5 -0
  304. package/node/@aws-s3/storage/directory/copy-dir/index.d.ts +9 -9
  305. package/node/@aws-s3/storage/directory/copy-dir/index.js +15 -12
  306. package/node/@aws-s3/storage/directory/list/index.d.ts +5 -5
  307. package/node/@aws-s3/storage/directory/list/index.js +5 -5
  308. package/node/@aws-s3/storage/directory/move-dir/index.d.ts +6 -6
  309. package/node/@aws-s3/storage/directory/move-dir/index.js +11 -7
  310. package/node/@aws-s3/storage/directory/remove-dir/index.d.ts +5 -5
  311. package/node/@aws-s3/storage/directory/remove-dir/index.js +5 -5
  312. package/node/@aws-s3/storage/file/copy/index.d.ts +8 -8
  313. package/node/@aws-s3/storage/file/copy/index.js +12 -9
  314. package/node/@aws-s3/storage/file/download/index.d.ts +6 -6
  315. package/node/@aws-s3/storage/file/download/index.js +6 -5
  316. package/node/@aws-s3/storage/file/exists/index.d.ts +6 -6
  317. package/node/@aws-s3/storage/file/exists/index.js +15 -12
  318. package/node/@aws-s3/storage/file/move/index.d.ts +9 -9
  319. package/node/@aws-s3/storage/file/move/index.js +18 -15
  320. package/node/@aws-s3/storage/file/remove/index.d.ts +5 -5
  321. package/node/@aws-s3/storage/file/remove/index.js +16 -11
  322. package/node/@aws-s3/storage/file/stat/index.d.ts +5 -5
  323. package/node/@aws-s3/storage/file/stat/index.js +10 -7
  324. package/node/@aws-s3/storage/file/upload/index.d.ts +7 -7
  325. package/node/@aws-s3/storage/file/upload/index.js +11 -9
  326. package/node/@express/@multer/index.d.ts +12 -12
  327. package/node/@express/@multer/index.js +27 -25
  328. package/node/@google-cloud/storage/bucket/get-metadata/index.d.ts +4 -4
  329. package/node/@google-cloud/storage/bucket/get-metadata/index.js +3 -3
  330. package/node/@google-cloud/storage/directory/copy-dir/index.d.ts +7 -7
  331. package/node/@google-cloud/storage/directory/copy-dir/index.js +6 -6
  332. package/node/@google-cloud/storage/directory/index.d.ts +1 -1
  333. package/node/@google-cloud/storage/directory/index.js +1 -1
  334. package/node/@google-cloud/storage/directory/list/index.d.ts +6 -6
  335. package/node/@google-cloud/storage/directory/list/index.js +5 -5
  336. package/node/@google-cloud/storage/directory/move-dir/index.d.ts +6 -6
  337. package/node/@google-cloud/storage/directory/move-dir/index.js +5 -5
  338. package/node/@google-cloud/storage/directory/remove-dir/index.d.ts +7 -7
  339. package/node/@google-cloud/storage/directory/remove-dir/index.js +6 -6
  340. package/node/@google-cloud/storage/file/copy/index.d.ts +9 -9
  341. package/node/@google-cloud/storage/file/copy/index.js +8 -8
  342. package/node/@google-cloud/storage/file/download/index.d.ts +7 -7
  343. package/node/@google-cloud/storage/file/download/index.js +5 -5
  344. package/node/@google-cloud/storage/file/exists/index.d.ts +7 -7
  345. package/node/@google-cloud/storage/file/exists/index.js +6 -6
  346. package/node/@google-cloud/storage/file/generate-signed-url/index.d.ts +7 -7
  347. package/node/@google-cloud/storage/file/generate-signed-url/index.js +6 -6
  348. package/node/@google-cloud/storage/file/get-metadata/index.d.ts +5 -5
  349. package/node/@google-cloud/storage/file/get-metadata/index.js +4 -4
  350. package/node/@google-cloud/storage/file/get-permissions/index.d.ts +6 -6
  351. package/node/@google-cloud/storage/file/get-permissions/index.js +4 -4
  352. package/node/@google-cloud/storage/file/index.d.ts +1 -1
  353. package/node/@google-cloud/storage/file/index.js +1 -1
  354. package/node/@google-cloud/storage/file/move/index.d.ts +10 -10
  355. package/node/@google-cloud/storage/file/move/index.js +9 -9
  356. package/node/@google-cloud/storage/file/remove/index.d.ts +5 -5
  357. package/node/@google-cloud/storage/file/remove/index.js +4 -4
  358. package/node/@google-cloud/storage/file/revoke-signed-urls/index.d.ts +5 -5
  359. package/node/@google-cloud/storage/file/revoke-signed-urls/index.js +5 -5
  360. package/node/@google-cloud/storage/file/stat/index.d.ts +5 -5
  361. package/node/@google-cloud/storage/file/stat/index.js +4 -4
  362. package/node/@google-cloud/storage/file/update-metadata/index.d.ts +7 -7
  363. package/node/@google-cloud/storage/file/update-metadata/index.js +5 -5
  364. package/node/@google-cloud/storage/file/upload/index.d.ts +7 -7
  365. package/node/@google-cloud/storage/file/upload/index.js +5 -5
  366. package/node/cloud-storage/clients/index.d.ts +8 -8
  367. package/node/cloud-storage/clients/index.js +8 -8
  368. package/node/cloud-storage/operations/copy-dir/index.d.ts +22 -22
  369. package/node/cloud-storage/operations/copy-dir/index.js +5 -5
  370. package/node/cloud-storage/operations/copy-file/index.d.ts +22 -22
  371. package/node/cloud-storage/operations/copy-file/index.js +5 -5
  372. package/node/cloud-storage/operations/download-file/index.d.ts +19 -19
  373. package/node/cloud-storage/operations/download-file/index.js +6 -6
  374. package/node/cloud-storage/operations/exists-file/index.d.ts +15 -26
  375. package/node/cloud-storage/operations/exists-file/index.js +4 -4
  376. package/node/cloud-storage/operations/list-dir/index.d.ts +15 -25
  377. package/node/cloud-storage/operations/list-dir/index.js +4 -4
  378. package/node/cloud-storage/operations/move-dir/index.d.ts +22 -22
  379. package/node/cloud-storage/operations/move-dir/index.js +5 -5
  380. package/node/cloud-storage/operations/move-file/index.d.ts +22 -22
  381. package/node/cloud-storage/operations/move-file/index.js +5 -5
  382. package/node/cloud-storage/operations/remove-dir/index.d.ts +18 -18
  383. package/node/cloud-storage/operations/remove-dir/index.js +4 -4
  384. package/node/cloud-storage/operations/remove-file/index.d.ts +18 -18
  385. package/node/cloud-storage/operations/remove-file/index.js +4 -4
  386. package/node/cloud-storage/operations/stat-file/index.d.ts +16 -16
  387. package/node/cloud-storage/operations/stat-file/index.js +4 -4
  388. package/node/cloud-storage/operations/upload-file/index.d.ts +23 -23
  389. package/node/cloud-storage/operations/upload-file/index.js +5 -5
  390. package/node/encryption/@aes-256-gcm/buffer/index.d.ts +6 -6
  391. package/node/encryption/@aes-256-gcm/buffer/index.js +6 -6
  392. package/node/encryption/@aes-256-gcm/uint8-array/index.d.ts +8 -8
  393. package/node/encryption/@aes-256-gcm/uint8-array/index.js +8 -8
  394. package/node/encryption/key/index.d.ts +6 -6
  395. package/node/encryption/key/index.js +6 -6
  396. package/node/files/read-write/index.d.ts +16 -16
  397. package/node/files/subpaths/index.d.ts +8 -8
  398. package/node/files/subpaths/index.js +11 -13
  399. package/node/ftps/directory/copy-dir/index.d.ts +6 -6
  400. package/node/ftps/directory/copy-dir/index.js +6 -6
  401. package/node/ftps/directory/list/index.d.ts +4 -4
  402. package/node/ftps/directory/list/index.js +3 -3
  403. package/node/ftps/directory/move-dir/index.d.ts +6 -6
  404. package/node/ftps/directory/move-dir/index.js +5 -5
  405. package/node/ftps/directory/remove-dir/index.d.ts +6 -6
  406. package/node/ftps/directory/remove-dir/index.js +8 -7
  407. package/node/ftps/file/copy/index.d.ts +6 -6
  408. package/node/ftps/file/copy/index.js +5 -5
  409. package/node/ftps/file/download/index.d.ts +6 -6
  410. package/node/ftps/file/download/index.js +5 -5
  411. package/node/ftps/file/exists/index.d.ts +3 -3
  412. package/node/ftps/file/exists/index.js +3 -3
  413. package/node/ftps/file/move/index.d.ts +8 -8
  414. package/node/ftps/file/move/index.js +11 -9
  415. package/node/ftps/file/remove/index.d.ts +5 -5
  416. package/node/ftps/file/remove/index.js +4 -4
  417. package/node/ftps/file/stat/index.d.ts +4 -4
  418. package/node/ftps/file/stat/index.js +4 -4
  419. package/node/ftps/file/upload/index.d.ts +7 -7
  420. package/node/ftps/file/upload/index.js +5 -5
  421. package/node/images/create/index.d.ts +2 -2
  422. package/node/images/create/index.js +1 -1
  423. package/node/images/format/index.d.ts +8 -8
  424. package/node/images/metadata/index.d.ts +2 -2
  425. package/node/images/transform/index.d.ts +2 -2
  426. package/node/images/transform/index.js +12 -2
  427. package/node/images/transform/operations/blur/index.d.ts +2 -2
  428. package/node/images/transform/operations/blur/index.js +1 -0
  429. package/node/images/transform/operations/brighten/index.d.ts +2 -2
  430. package/node/images/transform/operations/brighten/index.js +1 -0
  431. package/node/images/transform/operations/extend/index.d.ts +2 -2
  432. package/node/images/transform/operations/extend/index.js +1 -0
  433. package/node/images/transform/operations/extract/index.d.ts +2 -2
  434. package/node/images/transform/operations/extract/index.js +1 -0
  435. package/node/images/transform/operations/flatten/index.d.ts +2 -2
  436. package/node/images/transform/operations/flatten/index.js +1 -0
  437. package/node/images/transform/operations/flip/index.d.ts +2 -2
  438. package/node/images/transform/operations/flip/index.js +1 -0
  439. package/node/images/transform/operations/flop/index.d.ts +2 -2
  440. package/node/images/transform/operations/flop/index.js +1 -0
  441. package/node/images/transform/operations/hue/index.d.ts +2 -2
  442. package/node/images/transform/operations/hue/index.js +1 -0
  443. package/node/images/transform/operations/index.d.ts +2 -2
  444. package/node/images/transform/operations/index.js +2 -2
  445. package/node/images/transform/operations/level/index.d.ts +2 -2
  446. package/node/images/transform/operations/level/index.js +1 -0
  447. package/node/images/transform/operations/lighten/index.d.ts +2 -2
  448. package/node/images/transform/operations/lighten/index.js +1 -0
  449. package/node/images/transform/operations/normalize/index.d.ts +2 -2
  450. package/node/images/transform/operations/normalize/index.js +1 -0
  451. package/node/images/transform/operations/overlay/index.d.ts +2 -2
  452. package/node/images/transform/operations/resize/index.d.ts +2 -2
  453. package/node/images/transform/operations/resize/index.js +1 -0
  454. package/node/images/transform/operations/rotate/index.d.ts +2 -2
  455. package/node/images/transform/operations/rotate/index.js +1 -0
  456. package/node/images/transform/operations/saturate/index.d.ts +2 -2
  457. package/node/images/transform/operations/saturate/index.js +1 -0
  458. package/node/images/types.d.ts +41 -2
  459. package/node/images/utils/index.d.ts +10 -5
  460. package/node/process/index.d.ts +1 -1
  461. package/node/process/index.js +1 -1
  462. package/node/process/on-exit/index.js +2 -4
  463. package/node/process/prompt-continue/index.d.ts +3 -3
  464. package/node/process/prompt-continue/index.js +4 -3
  465. package/node/process/spawner/index.js +7 -6
  466. package/node/sftp/directory/copy-dir/index.d.ts +6 -6
  467. package/node/sftp/directory/copy-dir/index.js +6 -6
  468. package/node/sftp/directory/list/index.d.ts +3 -3
  469. package/node/sftp/directory/list/index.js +4 -4
  470. package/node/sftp/directory/move-dir/index.d.ts +7 -7
  471. package/node/sftp/directory/move-dir/index.js +7 -7
  472. package/node/sftp/directory/remove-dir/index.d.ts +5 -5
  473. package/node/sftp/directory/remove-dir/index.js +8 -7
  474. package/node/sftp/file/copy/index.d.ts +6 -6
  475. package/node/sftp/file/copy/index.js +5 -5
  476. package/node/sftp/file/download/index.d.ts +7 -7
  477. package/node/sftp/file/download/index.js +5 -5
  478. package/node/sftp/file/exists/index.d.ts +3 -3
  479. package/node/sftp/file/exists/index.js +3 -3
  480. package/node/sftp/file/index.d.ts +1 -1
  481. package/node/sftp/file/index.js +1 -1
  482. package/node/sftp/file/move/index.d.ts +7 -7
  483. package/node/sftp/file/move/index.js +7 -7
  484. package/node/sftp/file/remove/index.d.ts +4 -4
  485. package/node/sftp/file/remove/index.js +4 -4
  486. package/node/sftp/file/stat/index.d.ts +3 -3
  487. package/node/sftp/file/stat/index.js +6 -5
  488. package/node/sftp/file/upload/index.d.ts +6 -6
  489. package/node/sftp/file/upload/index.js +5 -5
  490. package/package.json +40 -39
@@ -2,10 +2,10 @@
2
2
  * Represents a successful outcome.
3
3
  *
4
4
  * @template Payload - The type of the success payload.
5
- * @property {true} success - Always `true`.
6
- * @property {Payload} payload - The success value.
5
+ * @property success - Always `true`.
6
+ * @property payload - The success value.
7
7
  */
8
- export type Success<Payload = any> = {
8
+ export type Success<Payload = unknown> = {
9
9
  success: true;
10
10
  payload: Payload;
11
11
  };
@@ -13,10 +13,10 @@ export type Success<Payload = any> = {
13
13
  * Represents a failed outcome.
14
14
  *
15
15
  * @template Error - The type of the error.
16
- * @property {false} success - Always `false`.
17
- * @property {Error} error - The error value.
16
+ * @property success - Always `false`.
17
+ * @property error - The error value.
18
18
  */
19
- export type Failure<Error = any> = {
19
+ export type Failure<Error = unknown> = {
20
20
  success: false;
21
21
  error: Error;
22
22
  };
@@ -26,21 +26,21 @@ export type Failure<Error = any> = {
26
26
  * @template Payload - Type of success payload.
27
27
  * @template Error - Type of error.
28
28
  */
29
- export type Either<Payload = any, Error = any> = Success<Payload> | Failure<Error>;
29
+ export type Either<Payload = unknown, Error = unknown> = Success<Payload> | Failure<Error>;
30
30
  /**
31
31
  * Creates a success outcome with the given payload.
32
32
  *
33
33
  * @template Payload
34
- * @param {Payload} payload - The success value.
35
- * @returns {Success<Payload>} A success outcome object.
34
+ * @param payload - The success value.
35
+ * @returns A success outcome object.
36
36
  */
37
37
  export declare function makeSuccess<Payload>(payload: Payload): Success<Payload>;
38
38
  /**
39
39
  * Creates a failure outcome with the given error.
40
40
  *
41
41
  * @template Error
42
- * @param {Error} error - The error value.
43
- * @returns {Failure<Error>} A failure outcome object.
42
+ * @param error - The error value.
43
+ * @returns A failure outcome object.
44
44
  */
45
45
  export declare function makeFailure<Error>(error: Error): Failure<Error>;
46
46
  /**
@@ -48,9 +48,9 @@ export declare function makeFailure<Error>(error: Error): Failure<Error>;
48
48
  *
49
49
  * @template Payload
50
50
  * @template Error
51
- * @param {boolean} success - `true` to create a success, `false` to create a failure.
52
- * @param {Payload | Error} payloadOrError - The payload if success, or the error if failure.
53
- * @returns {Either<Payload, Error>} The resulting outcome.
51
+ * @param success - `true` to create a success, `false` to create a failure.
52
+ * @param payloadOrError - The payload if success, or the error if failure.
53
+ * @returns The resulting outcome.
54
54
  */
55
55
  export declare function make<Payload>(success: true, payload: Payload): Success<Payload>;
56
56
  export declare function make<Error>(success: false, error: Error): Failure<Error>;
@@ -2,20 +2,22 @@
2
2
  * Creates a success outcome with the given payload.
3
3
  *
4
4
  * @template Payload
5
- * @param {Payload} payload - The success value.
6
- * @returns {Success<Payload>} A success outcome object.
5
+ * @param payload - The success value.
6
+ * @returns A success outcome object.
7
7
  */
8
8
  export function makeSuccess(payload) { return { success: true, payload }; }
9
9
  /**
10
10
  * Creates a failure outcome with the given error.
11
11
  *
12
12
  * @template Error
13
- * @param {Error} error - The error value.
14
- * @returns {Failure<Error>} A failure outcome object.
13
+ * @param error - The error value.
14
+ * @returns A failure outcome object.
15
15
  */
16
16
  export function makeFailure(error) { return { success: false, error }; }
17
17
  export function make(success, payloadOrError) {
18
18
  return success
19
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- guaranteed by the overload signatures above; the implementation signature can't express that link
19
20
  ? makeSuccess(payloadOrError)
21
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- guaranteed by the overload signatures above; the implementation signature can't express that link
20
22
  : makeFailure(payloadOrError);
21
23
  }
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Computes the modulo of a number, always returning a non-negative result.
3
3
  *
4
- * @param {number} nbr - The number to modulo.
5
- * @param {number} modulo - The modulus.
6
- * @returns {number} The non-negative remainder of `nbr` modulo `modulo`.
4
+ * @param nbr - The number to modulo.
5
+ * @param modulo - The modulus.
6
+ * @returns The non-negative remainder of `nbr` modulo `modulo`.
7
7
  */
8
8
  export declare function absoluteModulo(nbr: number, modulo: number): number;
@@ -1,9 +1,9 @@
1
1
  /**
2
2
  * Computes the modulo of a number, always returning a non-negative result.
3
3
  *
4
- * @param {number} nbr - The number to modulo.
5
- * @param {number} modulo - The modulus.
6
- * @returns {number} The non-negative remainder of `nbr` modulo `modulo`.
4
+ * @param nbr - The number to modulo.
5
+ * @param modulo - The modulus.
6
+ * @returns The non-negative remainder of `nbr` modulo `modulo`.
7
7
  */
8
8
  export function absoluteModulo(nbr, modulo) {
9
9
  return ((nbr % modulo) + modulo) % modulo;
@@ -4,9 +4,9 @@
4
4
  * Uses a naive algorithm that increments the numerator or denominator each round
5
5
  * to find the closest approximation. Stops early if an exact match is found.
6
6
  *
7
- * @param {number} target - The decimal number to approximate.
8
- * @param {number} maxRounds - The maximum number of iterations to perform.
9
- * @returns {[number, number]} A tuple `[numerator, denominator]` representing the rational approximation.
7
+ * @param target - The decimal number to approximate.
8
+ * @param maxRounds - The maximum number of iterations to perform.
9
+ * @returns A tuple `[numerator, denominator]` representing the rational approximation.
10
10
  */
11
11
  export declare function approximateRationalDumb(target: number, maxRounds: number): [number, number];
12
12
  /**
@@ -15,8 +15,8 @@ export declare function approximateRationalDumb(target: number, maxRounds: numbe
15
15
  * Uses the continued fractions algorithm to find the best rational approximation
16
16
  * of a decimal number within the specified maximum denominator limit.
17
17
  *
18
- * @param {number} target - The decimal number to approximate.
19
- * @param {number} [maxDenominator=1000] - The maximum allowed denominator value.
20
- * @returns {[number, number]} A tuple `[numerator, denominator]` representing the rational approximation.
18
+ * @param target - The decimal number to approximate.
19
+ * @param [maxDenominator=1000] - The maximum allowed denominator value.
20
+ * @returns A tuple `[numerator, denominator]` representing the rational approximation.
21
21
  */
22
22
  export declare function approximateRational(target: number, maxDenominator?: number): [number, number];
@@ -4,9 +4,9 @@
4
4
  * Uses a naive algorithm that increments the numerator or denominator each round
5
5
  * to find the closest approximation. Stops early if an exact match is found.
6
6
  *
7
- * @param {number} target - The decimal number to approximate.
8
- * @param {number} maxRounds - The maximum number of iterations to perform.
9
- * @returns {[number, number]} A tuple `[numerator, denominator]` representing the rational approximation.
7
+ * @param target - The decimal number to approximate.
8
+ * @param maxRounds - The maximum number of iterations to perform.
9
+ * @returns A tuple `[numerator, denominator]` representing the rational approximation.
10
10
  */
11
11
  export function approximateRationalDumb(target, maxRounds) {
12
12
  let numerator = 0;
@@ -20,7 +20,7 @@ export function approximateRationalDumb(target, maxRounds) {
20
20
  };
21
21
  const positiveTarget = Math.abs(target);
22
22
  while (currentRound < maxRounds && !foundExact) {
23
- currentRound++;
23
+ currentRound = currentRound + 1;
24
24
  const roundResult = numerator / denominator;
25
25
  if (roundResult === positiveTarget) {
26
26
  closestFound.numerator = numerator;
@@ -37,10 +37,10 @@ export function approximateRationalDumb(target, maxRounds) {
37
37
  closestFound.found = roundResult;
38
38
  }
39
39
  if (roundResult < positiveTarget) {
40
- numerator++;
40
+ numerator = numerator + 1;
41
41
  }
42
42
  else {
43
- denominator++;
43
+ denominator = denominator + 1;
44
44
  }
45
45
  }
46
46
  }
@@ -58,9 +58,9 @@ export function approximateRationalDumb(target, maxRounds) {
58
58
  * Uses the continued fractions algorithm to find the best rational approximation
59
59
  * of a decimal number within the specified maximum denominator limit.
60
60
  *
61
- * @param {number} target - The decimal number to approximate.
62
- * @param {number} [maxDenominator=1000] - The maximum allowed denominator value.
63
- * @returns {[number, number]} A tuple `[numerator, denominator]` representing the rational approximation.
61
+ * @param target - The decimal number to approximate.
62
+ * @param [maxDenominator=1000] - The maximum allowed denominator value.
63
+ * @returns A tuple `[numerator, denominator]` representing the rational approximation.
64
64
  */
65
65
  export function approximateRational(target, maxDenominator = 1000) {
66
66
  const sign = target < 0 ? -1 : 1;
@@ -1,9 +1,9 @@
1
1
  /**
2
2
  * Restricts a number to lie within a specified range.
3
3
  *
4
- * @param {number} num - The number to clamp.
5
- * @param {number} bound1 - One end of the range.
6
- * @param {number} bound2 - The other end of the range.
7
- * @returns {number} The number constrained between the minimum and maximum of the two bounds.
4
+ * @param num - The number to clamp.
5
+ * @param bound1 - One end of the range.
6
+ * @param bound2 - The other end of the range.
7
+ * @returns The number constrained between the minimum and maximum of the two bounds.
8
8
  */
9
9
  export declare function clamp(num: number, bound1: number, bound2: number): number;
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * Restricts a number to lie within a specified range.
3
3
  *
4
- * @param {number} num - The number to clamp.
5
- * @param {number} bound1 - One end of the range.
6
- * @param {number} bound2 - The other end of the range.
7
- * @returns {number} The number constrained between the minimum and maximum of the two bounds.
4
+ * @param num - The number to clamp.
5
+ * @param bound1 - One end of the range.
6
+ * @param bound2 - The other end of the range.
7
+ * @returns The number constrained between the minimum and maximum of the two bounds.
8
8
  */
9
9
  export function clamp(num, bound1, bound2) {
10
10
  const min = Math.min(bound1, bound2);
@@ -5,10 +5,10 @@
5
5
  * This function divides the range [min, max] multiplicatively (logarithmically)
6
6
  * across `steps` and returns the value corresponding to `level` (1-based).
7
7
  *
8
- * @param {number} min - The minimum value (must be non-zero).
9
- * @param {number} max - The maximum value.
10
- * @param {number} level - The current level (1-based, typically 1 ≤ level ≤ steps).
11
- * @param {number} steps - Total number of steps (must be ≥ 1).
12
- * @returns {number} The computed value at the specified level, or `NaN` if input is invalid.
8
+ * @param min - The minimum value (must be non-zero).
9
+ * @param max - The maximum value.
10
+ * @param level - The current level (1-based, typically 1 ≤ level ≤ steps).
11
+ * @param steps - Total number of steps (must be ≥ 1).
12
+ * @returns The computed value at the specified level, or `NaN` if input is invalid.
13
13
  */
14
14
  export declare function getGeometricStep(min: number, max: number, level: number, steps: number): number;
@@ -5,18 +5,20 @@
5
5
  * This function divides the range [min, max] multiplicatively (logarithmically)
6
6
  * across `steps` and returns the value corresponding to `level` (1-based).
7
7
  *
8
- * @param {number} min - The minimum value (must be non-zero).
9
- * @param {number} max - The maximum value.
10
- * @param {number} level - The current level (1-based, typically 1 ≤ level ≤ steps).
11
- * @param {number} steps - Total number of steps (must be ≥ 1).
12
- * @returns {number} The computed value at the specified level, or `NaN` if input is invalid.
8
+ * @param min - The minimum value (must be non-zero).
9
+ * @param max - The maximum value.
10
+ * @param level - The current level (1-based, typically 1 ≤ level ≤ steps).
11
+ * @param steps - Total number of steps (must be ≥ 1).
12
+ * @returns The computed value at the specified level, or `NaN` if input is invalid.
13
13
  */
14
14
  export function getGeometricStep(min, max, level, steps) {
15
15
  if (min === 0) {
16
+ // eslint-disable-next-line no-console
16
17
  console.warn('Cannot generate values if min value is zero');
17
18
  return NaN;
18
19
  }
19
20
  if (steps < 1) {
21
+ // eslint-disable-next-line no-console
20
22
  console.warn('Cannot generate values if steps is lower than one');
21
23
  return NaN;
22
24
  }
@@ -23,13 +23,13 @@ describe('getGeometricStep', () => {
23
23
  expect(values[4]).toBeCloseTo(16);
24
24
  });
25
25
  it('returns NaN if min is zero', () => {
26
- const spy = vi.spyOn(console, 'warn').mockImplementation(() => { });
26
+ const spy = vi.spyOn(console, 'warn').mockImplementation(() => undefined);
27
27
  expect(getGeometricStep(0, 10, 1, 5)).toBeNaN();
28
28
  expect(spy).toHaveBeenCalledWith('Cannot generate values if min value is zero');
29
29
  spy.mockRestore();
30
30
  });
31
31
  it('returns NaN if steps is less than 1', () => {
32
- const spy = vi.spyOn(console, 'warn').mockImplementation(() => { });
32
+ const spy = vi.spyOn(console, 'warn').mockImplementation(() => undefined);
33
33
  expect(getGeometricStep(1, 10, 1, 0)).toBeNaN();
34
34
  expect(spy).toHaveBeenCalledWith('Cannot generate values if steps is lower than one');
35
35
  spy.mockRestore();
@@ -1,6 +1,6 @@
1
1
  export * as absoluteModulo from './absolute-modulo/index.js'
2
2
  export * as approximateRational from './approximate-rational/index.js'
3
3
  export * as clamp from './clamp/index.js'
4
- export * as interpolate from './interpolate/index.js'
5
4
  export * as geometricProgressions from './geometric-progressions/index.js'
5
+ export * as interpolate from './interpolate/index.js'
6
6
  export * as round from './round/index.js'
@@ -1,6 +1,6 @@
1
1
  export * as absoluteModulo from './absolute-modulo/index.js'
2
2
  export * as approximateRational from './approximate-rational/index.js'
3
3
  export * as clamp from './clamp/index.js'
4
- export * as interpolate from './interpolate/index.js'
5
4
  export * as geometricProgressions from './geometric-progressions/index.js'
5
+ export * as interpolate from './interpolate/index.js'
6
6
  export * as round from './round/index.js'
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * Performs linear interpolation between two bounds based on a ratio.
3
3
  *
4
- * @param {number} ratio - The interpolation factor, typically between 0 and 1.
5
- * @param {number} bound1 - The start value.
6
- * @param {number} bound2 - The end value.
7
- * @returns {number} The interpolated value between `bound1` and `bound2`.
4
+ * @param ratio - The interpolation factor, typically between 0 and 1.
5
+ * @param bound1 - The start value.
6
+ * @param bound2 - The end value.
7
+ * @returns The interpolated value between `bound1` and `bound2`.
8
8
  */
9
9
  export declare function interpolate(ratio: number, bound1: number, bound2: number): number;
10
10
  /**
@@ -13,9 +13,9 @@ export declare function interpolate(ratio: number, bound1: number, bound2: numbe
13
13
  * If only `bound1` is provided, returns the ratio of `value / bound1`.
14
14
  * If both bounds are provided, returns the normalized position of `value` between `bound1` and `bound2`.
15
15
  *
16
- * @param {number} value - The value to normalize.
17
- * @param {number} bound1 - The lower bound (or single reference value if `bound2` is omitted).
18
- * @param {number} [bound2] - The upper bound (optional).
19
- * @returns {number} A ratio representing the relative position of `value`.
16
+ * @param value - The value to normalize.
17
+ * @param bound1 - The lower bound (or single reference value if `bound2` is omitted).
18
+ * @param [bound2] - The upper bound (optional).
19
+ * @returns A ratio representing the relative position of `value`.
20
20
  */
21
21
  export declare function unlerp(value: number, bound1: number, bound2?: number): number;
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * Performs linear interpolation between two bounds based on a ratio.
3
3
  *
4
- * @param {number} ratio - The interpolation factor, typically between 0 and 1.
5
- * @param {number} bound1 - The start value.
6
- * @param {number} bound2 - The end value.
7
- * @returns {number} The interpolated value between `bound1` and `bound2`.
4
+ * @param ratio - The interpolation factor, typically between 0 and 1.
5
+ * @param bound1 - The start value.
6
+ * @param bound2 - The end value.
7
+ * @returns The interpolated value between `bound1` and `bound2`.
8
8
  */
9
9
  export function interpolate(ratio, bound1, bound2) {
10
10
  return bound1 + ratio * (bound2 - bound1);
@@ -15,10 +15,10 @@ export function interpolate(ratio, bound1, bound2) {
15
15
  * If only `bound1` is provided, returns the ratio of `value / bound1`.
16
16
  * If both bounds are provided, returns the normalized position of `value` between `bound1` and `bound2`.
17
17
  *
18
- * @param {number} value - The value to normalize.
19
- * @param {number} bound1 - The lower bound (or single reference value if `bound2` is omitted).
20
- * @param {number} [bound2] - The upper bound (optional).
21
- * @returns {number} A ratio representing the relative position of `value`.
18
+ * @param value - The value to normalize.
19
+ * @param bound1 - The lower bound (or single reference value if `bound2` is omitted).
20
+ * @param [bound2] - The upper bound (optional).
21
+ * @returns A ratio representing the relative position of `value`.
22
22
  */
23
23
  export function unlerp(value, bound1, bound2) {
24
24
  if (bound2 === undefined)
@@ -1,24 +1,24 @@
1
1
  /**
2
2
  * Rounds a number to/down a specified number of decimal places.
3
3
  *
4
- * @param {number} number - The number to round.
5
- * @param {number} nbDecimals - Number of decimal places. Defaults to 0
6
- * @returns {number} The rounded number.
4
+ * @param number - The number to round.
5
+ * @param nbDecimals - Number of decimal places. Defaults to 0
6
+ * @returns The rounded number.
7
7
  */
8
8
  export declare function round(number: number, nbDecimals?: number): number;
9
9
  /**
10
10
  * Ceils a number up to a specified number of decimal places.
11
11
  *
12
- * @param {number} number - The number to round up.
13
- * @param {number} nbDecimals - Number of decimal places. Defaults to 0
14
- * @returns {number} The ceiled-up number.
12
+ * @param number - The number to round up.
13
+ * @param nbDecimals - Number of decimal places. Defaults to 0
14
+ * @returns The ceiled-up number.
15
15
  */
16
16
  export declare function ceil(number: number, nbDecimals?: number): number;
17
17
  /**
18
18
  * Floors a number down to a specified number of decimal places.
19
19
  *
20
- * @param {number} number - The number to round down.
21
- * @param {number} nbDecimals - Number of decimal places. Defaults to 0
22
- * @returns {number} The floored-down number.
20
+ * @param number - The number to round down.
21
+ * @param nbDecimals - Number of decimal places. Defaults to 0
22
+ * @returns The floored-down number.
23
23
  */
24
24
  export declare function floor(number: number, nbDecimals?: number): number;
@@ -1,9 +1,9 @@
1
1
  /**
2
2
  * Rounds a number to/down a specified number of decimal places.
3
3
  *
4
- * @param {number} number - The number to round.
5
- * @param {number} nbDecimals - Number of decimal places. Defaults to 0
6
- * @returns {number} The rounded number.
4
+ * @param number - The number to round.
5
+ * @param nbDecimals - Number of decimal places. Defaults to 0
6
+ * @returns The rounded number.
7
7
  */
8
8
  export function round(number, nbDecimals = 0) {
9
9
  const multiplier = Math.pow(10, nbDecimals);
@@ -12,9 +12,9 @@ export function round(number, nbDecimals = 0) {
12
12
  /**
13
13
  * Ceils a number up to a specified number of decimal places.
14
14
  *
15
- * @param {number} number - The number to round up.
16
- * @param {number} nbDecimals - Number of decimal places. Defaults to 0
17
- * @returns {number} The ceiled-up number.
15
+ * @param number - The number to round up.
16
+ * @param nbDecimals - Number of decimal places. Defaults to 0
17
+ * @returns The ceiled-up number.
18
18
  */
19
19
  export function ceil(number, nbDecimals = 0) {
20
20
  const multiplier = Math.pow(10, nbDecimals);
@@ -23,9 +23,9 @@ export function ceil(number, nbDecimals = 0) {
23
23
  /**
24
24
  * Floors a number down to a specified number of decimal places.
25
25
  *
26
- * @param {number} number - The number to round down.
27
- * @param {number} nbDecimals - Number of decimal places. Defaults to 0
28
- * @returns {number} The floored-down number.
26
+ * @param number - The number to round down.
27
+ * @param nbDecimals - Number of decimal places. Defaults to 0
28
+ * @returns The floored-down number.
29
29
  */
30
30
  export function floor(number, nbDecimals = 0) {
31
31
  const multiplier = Math.pow(10, nbDecimals);
@@ -1,9 +1,9 @@
1
1
  /**
2
2
  * Safely retrieves a nested property from an object using a dot-separated path string.
3
3
  *
4
- * @param {unknown} anythingThatHasProperties - The object (or record) to traverse.
5
- * @param {string} pathString - Dot-separated path of the property to retrieve (e.g., `'a.b.c'`).
6
- * @returns {any} The value at the specified path.
4
+ * @param anythingThatHasProperties - The object (or record) to traverse.
5
+ * @param pathString - Dot-separated path of the property to retrieve (e.g., `'a.b.c'`).
6
+ * @returns The value at the specified path.
7
7
  * @throws {string} `'PROPERTY_UNREACHABLE'` if any part of the path is inaccessible or not an object.
8
8
  */
9
- export declare function deepGetProperty(anythingThatHasProperties: unknown, pathString: string): any;
9
+ export declare function deepGetProperty(anythingThatHasProperties: unknown, pathString: string): unknown;
@@ -2,9 +2,9 @@ import { isRecord } from '../is-record/index.js';
2
2
  /**
3
3
  * Safely retrieves a nested property from an object using a dot-separated path string.
4
4
  *
5
- * @param {unknown} anythingThatHasProperties - The object (or record) to traverse.
6
- * @param {string} pathString - Dot-separated path of the property to retrieve (e.g., `'a.b.c'`).
7
- * @returns {any} The value at the specified path.
5
+ * @param anythingThatHasProperties - The object (or record) to traverse.
6
+ * @param pathString - Dot-separated path of the property to retrieve (e.g., `'a.b.c'`).
7
+ * @returns The value at the specified path.
8
8
  * @throws {string} `'PROPERTY_UNREACHABLE'` if any part of the path is inaccessible or not an object.
9
9
  */
10
10
  export function deepGetProperty(anythingThatHasProperties, pathString) {
@@ -4,8 +4,8 @@
4
4
  * Works with both string and numeric enums, ignoring reverse mappings in numeric enums.
5
5
  *
6
6
  * @template E - The enum type.
7
- * @param {E} enumObj - The enum object to check against.
8
- * @param {string | number} value - The value to test.
9
- * @returns {value is E[keyof E]} `true` if the value is a valid enum member, otherwise `false`.
7
+ * @param enumObj - The enum object to check against.
8
+ * @param value - The value to test.
9
+ * @returns `true` if the value is a valid enum member, otherwise `false`.
10
10
  */
11
11
  export declare function isInEnum<E extends Record<string, string | number>>(enumObj: E, value: string | number): value is E[keyof E];
@@ -4,9 +4,9 @@
4
4
  * Works with both string and numeric enums, ignoring reverse mappings in numeric enums.
5
5
  *
6
6
  * @template E - The enum type.
7
- * @param {E} enumObj - The enum object to check against.
8
- * @param {string | number} value - The value to test.
9
- * @returns {value is E[keyof E]} `true` if the value is a valid enum member, otherwise `false`.
7
+ * @param enumObj - The enum object to check against.
8
+ * @param value - The value to test.
9
+ * @returns `true` if the value is a valid enum member, otherwise `false`.
10
10
  */
11
11
  export function isInEnum(enumObj, value) {
12
12
  const keys = Object.keys(enumObj);
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Returns a shallow copy of an object including values from its getter properties.
3
3
  *
4
- * @param {object} obj - The object to flatten.
5
- * @returns {Record<string, unknown>} A new object containing all own properties and evaluated getter values.
4
+ * @param obj - The object to flatten.
5
+ * @returns A new object containing all own properties and evaluated getter values.
6
6
  */
7
7
  export declare function flattenGetters(obj: object): Record<string, unknown>;
@@ -1,14 +1,15 @@
1
1
  /**
2
2
  * Returns a shallow copy of an object including values from its getter properties.
3
3
  *
4
- * @param {object} obj - The object to flatten.
5
- * @returns {Record<string, unknown>} A new object containing all own properties and evaluated getter values.
4
+ * @param obj - The object to flatten.
5
+ * @returns A new object containing all own properties and evaluated getter values.
6
6
  */
7
7
  export function flattenGetters(obj) {
8
8
  const getters = Object.entries(Object.getOwnPropertyDescriptors(obj)).filter(([_, desc]) => (typeof desc.get === 'function'))
9
9
  .map(([key]) => key);
10
10
  const returned = { ...obj };
11
11
  getters.forEach(getter => {
12
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- getter came from Object.getOwnPropertyDescriptors(obj)'s own keys, so it's always a key of obj
12
13
  const key = getter;
13
14
  returned[getter] = obj[key];
14
15
  });
@@ -1,9 +1,9 @@
1
1
  export * as deepGetProperty from './deep-get-property/index.js'
2
2
  export * as enums from './enums/index.js'
3
+ export * as flattenGetters from './flatten-getters/index.js'
3
4
  export * as isObject from './is-object/index.js'
4
5
  export * as isRecord from './is-record/index.js'
5
6
  export * as recordFormat from './record-format/index.js'
6
- export * as flattenGetters from './flatten-getters/index.js'
7
- export * as sortKeys from './sort-keys/index.js'
8
7
  export * as recordMap from './record-map/index.js'
8
+ export * as sortKeys from './sort-keys/index.js'
9
9
  export * as validation from './validation/index.js'
@@ -1,9 +1,9 @@
1
1
  export * as deepGetProperty from './deep-get-property/index.js'
2
2
  export * as enums from './enums/index.js'
3
+ export * as flattenGetters from './flatten-getters/index.js'
3
4
  export * as isObject from './is-object/index.js'
4
5
  export * as isRecord from './is-record/index.js'
5
6
  export * as recordFormat from './record-format/index.js'
6
- export * as flattenGetters from './flatten-getters/index.js'
7
- export * as sortKeys from './sort-keys/index.js'
8
7
  export * as recordMap from './record-map/index.js'
8
+ export * as sortKeys from './sort-keys/index.js'
9
9
  export * as validation from './validation/index.js'
@@ -1,14 +1,14 @@
1
1
  /**
2
2
  * Checks if a value is of type "object", including `null`.
3
3
  *
4
- * @param {unknown} unk - The value to check.
5
- * @returns {unk is object | null} `true` if the value is an object or `null`, otherwise `false`.
4
+ * @param unk - The value to check.
5
+ * @returns `true` if the value is an object or `null`, otherwise `false`.
6
6
  */
7
7
  export declare function isObject(unk: unknown): unk is object | null;
8
8
  /**
9
9
  * Checks if a value is a non-null object.
10
10
  *
11
- * @param {unknown} unk - The value to check.
12
- * @returns {unk is object} `true` if the value is a non-null object, otherwise `false`.
11
+ * @param unk - The value to check.
12
+ * @returns `true` if the value is a non-null object, otherwise `false`.
13
13
  */
14
14
  export declare function isNonNullObject(unk: unknown): unk is object;
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Checks if a value is of type "object", including `null`.
3
3
  *
4
- * @param {unknown} unk - The value to check.
5
- * @returns {unk is object | null} `true` if the value is an object or `null`, otherwise `false`.
4
+ * @param unk - The value to check.
5
+ * @returns `true` if the value is an object or `null`, otherwise `false`.
6
6
  */
7
7
  export function isObject(unk) {
8
8
  return typeof unk === 'object';
@@ -10,8 +10,8 @@ export function isObject(unk) {
10
10
  /**
11
11
  * Checks if a value is a non-null object.
12
12
  *
13
- * @param {unknown} unk - The value to check.
14
- * @returns {unk is object} `true` if the value is a non-null object, otherwise `false`.
13
+ * @param unk - The value to check.
14
+ * @returns `true` if the value is a non-null object, otherwise `false`.
15
15
  */
16
16
  export function isNonNullObject(unk) {
17
17
  return unk !== null && isObject(unk);
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Checks if a value is a plain object with string keys.
3
3
  *
4
- * @param {unknown} input - The value to check.
5
- * @returns {input is Record<string, unknown>} `true` if the value is an object with string keys, otherwise `false`.
4
+ * @param input - The value to check.
5
+ * @returns `true` if the value is an object with string keys, otherwise `false`.
6
6
  */
7
7
  export declare function isRecord(input: unknown): input is Record<string, unknown>;
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Checks if a value is a plain object with string keys.
3
3
  *
4
- * @param {unknown} input - The value to check.
5
- * @returns {input is Record<string, unknown>} `true` if the value is an object with string keys, otherwise `false`.
4
+ * @param input - The value to check.
5
+ * @returns `true` if the value is an object with string keys, otherwise `false`.
6
6
  */
7
7
  export function isRecord(input) {
8
8
  if (typeof input !== 'object' || input === null)