rubico 2.3.0 → 2.3.1

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 (419) hide show
  1. package/AggregateReducer.d.ts +10 -0
  2. package/Transducer.d.ts +231 -0
  3. package/__.d.ts +2 -0
  4. package/_internal/EmptyMap.d.ts +2 -0
  5. package/_internal/arrayFind.d.ts +15 -0
  6. package/_internal/asyncIteratorFind.d.ts +12 -0
  7. package/_internal/iteratorFind.d.ts +12 -0
  8. package/_internal/thunkify5.d.ts +20 -0
  9. package/_internal/timeInLoop.d.ts +25 -0
  10. package/_internal/timeInLoopAsync.d.ts +23 -0
  11. package/all.d.ts +100 -0
  12. package/always.d.ts +2 -0
  13. package/and.d.ts +45 -0
  14. package/assign.d.ts +46 -0
  15. package/compose.d.ts +25 -0
  16. package/curry.d.ts +70 -0
  17. package/dist/Transducer.es.js +1 -1
  18. package/dist/Transducer.es.min.js +1 -1
  19. package/dist/Transducer.js +1 -1
  20. package/dist/Transducer.min.js +1 -1
  21. package/dist/Transducer.mjs +1 -1
  22. package/dist/__.es.js +1 -1
  23. package/dist/__.es.min.js +1 -1
  24. package/dist/__.js +1 -1
  25. package/dist/__.min.js +1 -1
  26. package/dist/__.mjs +1 -1
  27. package/dist/all.es.js +1 -1
  28. package/dist/all.es.min.js +1 -1
  29. package/dist/all.js +1 -1
  30. package/dist/all.min.js +1 -1
  31. package/dist/all.mjs +1 -1
  32. package/dist/always.es.js +1 -1
  33. package/dist/always.es.min.js +1 -1
  34. package/dist/always.js +1 -1
  35. package/dist/always.min.js +1 -1
  36. package/dist/always.mjs +1 -1
  37. package/dist/and.es.js +1 -1
  38. package/dist/and.es.min.js +1 -1
  39. package/dist/and.js +1 -1
  40. package/dist/and.min.js +1 -1
  41. package/dist/and.mjs +1 -1
  42. package/dist/assign.es.js +1 -1
  43. package/dist/assign.es.min.js +1 -1
  44. package/dist/assign.js +1 -1
  45. package/dist/assign.min.js +1 -1
  46. package/dist/assign.mjs +1 -1
  47. package/dist/compose.es.js +1 -1
  48. package/dist/compose.es.min.js +1 -1
  49. package/dist/compose.js +1 -1
  50. package/dist/compose.min.js +1 -1
  51. package/dist/compose.mjs +1 -1
  52. package/dist/curry.es.js +1 -1
  53. package/dist/curry.es.min.js +1 -1
  54. package/dist/curry.js +1 -1
  55. package/dist/curry.min.js +1 -1
  56. package/dist/curry.mjs +1 -1
  57. package/dist/eq.es.js +1 -1
  58. package/dist/eq.es.min.js +1 -1
  59. package/dist/eq.js +1 -1
  60. package/dist/eq.min.js +1 -1
  61. package/dist/eq.mjs +1 -1
  62. package/dist/every.es.js +1 -1
  63. package/dist/every.es.min.js +1 -1
  64. package/dist/every.js +1 -1
  65. package/dist/every.min.js +1 -1
  66. package/dist/every.mjs +1 -1
  67. package/dist/filter.es.js +1 -1
  68. package/dist/filter.es.min.js +1 -1
  69. package/dist/filter.js +1 -1
  70. package/dist/filter.min.js +1 -1
  71. package/dist/filter.mjs +1 -1
  72. package/dist/flatMap.es.js +1 -1
  73. package/dist/flatMap.es.min.js +1 -1
  74. package/dist/flatMap.js +1 -1
  75. package/dist/flatMap.min.js +1 -1
  76. package/dist/flatMap.mjs +1 -1
  77. package/dist/forEach.es.js +1 -1
  78. package/dist/forEach.es.min.js +1 -1
  79. package/dist/forEach.js +1 -1
  80. package/dist/forEach.min.js +1 -1
  81. package/dist/forEach.mjs +1 -1
  82. package/dist/get.es.js +1 -1
  83. package/dist/get.es.min.js +1 -1
  84. package/dist/get.js +1 -1
  85. package/dist/get.min.js +1 -1
  86. package/dist/get.mjs +1 -1
  87. package/dist/gt.es.js +1 -1
  88. package/dist/gt.es.min.js +1 -1
  89. package/dist/gt.js +1 -1
  90. package/dist/gt.min.js +1 -1
  91. package/dist/gt.mjs +1 -1
  92. package/dist/gte.es.js +1 -1
  93. package/dist/gte.es.min.js +1 -1
  94. package/dist/gte.js +1 -1
  95. package/dist/gte.min.js +1 -1
  96. package/dist/gte.mjs +1 -1
  97. package/dist/lt.es.js +1 -1
  98. package/dist/lt.es.min.js +1 -1
  99. package/dist/lt.js +1 -1
  100. package/dist/lt.min.js +1 -1
  101. package/dist/lt.mjs +1 -1
  102. package/dist/lte.es.js +1 -1
  103. package/dist/lte.es.min.js +1 -1
  104. package/dist/lte.js +1 -1
  105. package/dist/lte.min.js +1 -1
  106. package/dist/lte.mjs +1 -1
  107. package/dist/map.es.js +1 -1
  108. package/dist/map.es.min.js +1 -1
  109. package/dist/map.js +1 -1
  110. package/dist/map.min.js +1 -1
  111. package/dist/map.mjs +1 -1
  112. package/dist/not.es.js +1 -1
  113. package/dist/not.es.min.js +1 -1
  114. package/dist/not.js +1 -1
  115. package/dist/not.min.js +1 -1
  116. package/dist/not.mjs +1 -1
  117. package/dist/omit.es.js +1 -1
  118. package/dist/omit.es.min.js +1 -1
  119. package/dist/omit.js +1 -1
  120. package/dist/omit.min.js +1 -1
  121. package/dist/omit.mjs +1 -1
  122. package/dist/or.es.js +1 -1
  123. package/dist/or.es.min.js +1 -1
  124. package/dist/or.js +1 -1
  125. package/dist/or.min.js +1 -1
  126. package/dist/or.mjs +1 -1
  127. package/dist/pick.es.js +1 -1
  128. package/dist/pick.es.min.js +1 -1
  129. package/dist/pick.js +1 -1
  130. package/dist/pick.min.js +1 -1
  131. package/dist/pick.mjs +1 -1
  132. package/dist/pipe.es.js +1 -1
  133. package/dist/pipe.es.min.js +1 -1
  134. package/dist/pipe.js +1 -1
  135. package/dist/pipe.min.js +1 -1
  136. package/dist/pipe.mjs +1 -1
  137. package/dist/reduce.es.js +1 -1
  138. package/dist/reduce.es.min.js +1 -1
  139. package/dist/reduce.js +1 -1
  140. package/dist/reduce.min.js +1 -1
  141. package/dist/reduce.mjs +1 -1
  142. package/dist/rubico.es.js +1 -1
  143. package/dist/rubico.es.min.js +1 -1
  144. package/dist/rubico.global.js +1 -1
  145. package/dist/rubico.global.min.js +1 -1
  146. package/dist/rubico.js +1 -1
  147. package/dist/rubico.min.js +1 -1
  148. package/dist/rubico.mjs +1 -1
  149. package/dist/set.es.js +1 -1
  150. package/dist/set.es.min.js +1 -1
  151. package/dist/set.js +1 -1
  152. package/dist/set.min.js +1 -1
  153. package/dist/set.mjs +1 -1
  154. package/dist/some.es.js +1 -1
  155. package/dist/some.es.min.js +1 -1
  156. package/dist/some.js +1 -1
  157. package/dist/some.min.js +1 -1
  158. package/dist/some.mjs +1 -1
  159. package/dist/switchCase.es.js +1 -1
  160. package/dist/switchCase.es.min.js +1 -1
  161. package/dist/switchCase.js +1 -1
  162. package/dist/switchCase.min.js +1 -1
  163. package/dist/switchCase.mjs +1 -1
  164. package/dist/tap.es.js +1 -1
  165. package/dist/tap.es.min.js +1 -1
  166. package/dist/tap.js +1 -1
  167. package/dist/tap.min.js +1 -1
  168. package/dist/tap.mjs +1 -1
  169. package/dist/thunkify.es.js +1 -1
  170. package/dist/thunkify.es.min.js +1 -1
  171. package/dist/thunkify.js +1 -1
  172. package/dist/thunkify.min.js +1 -1
  173. package/dist/thunkify.mjs +1 -1
  174. package/dist/transform.es.js +1 -1
  175. package/dist/transform.es.min.js +1 -1
  176. package/dist/transform.js +1 -1
  177. package/dist/transform.min.js +1 -1
  178. package/dist/transform.mjs +1 -1
  179. package/dist/tryCatch.es.js +1 -1
  180. package/dist/tryCatch.es.min.js +1 -1
  181. package/dist/tryCatch.js +1 -1
  182. package/dist/tryCatch.min.js +1 -1
  183. package/dist/tryCatch.mjs +1 -1
  184. package/dist/x/append.es.js +1 -1
  185. package/dist/x/append.es.min.js +1 -1
  186. package/dist/x/append.js +1 -1
  187. package/dist/x/append.min.js +1 -1
  188. package/dist/x/append.mjs +1 -1
  189. package/dist/x/callProp.es.js +1 -1
  190. package/dist/x/callProp.es.min.js +1 -1
  191. package/dist/x/callProp.js +1 -1
  192. package/dist/x/callProp.min.js +1 -1
  193. package/dist/x/callProp.mjs +1 -1
  194. package/dist/x/defaultsDeep.es.js +1 -1
  195. package/dist/x/defaultsDeep.es.min.js +1 -1
  196. package/dist/x/defaultsDeep.js +1 -1
  197. package/dist/x/defaultsDeep.min.js +1 -1
  198. package/dist/x/defaultsDeep.mjs +1 -1
  199. package/dist/x/differenceWith.es.js +1 -1
  200. package/dist/x/differenceWith.es.min.js +1 -1
  201. package/dist/x/differenceWith.js +1 -1
  202. package/dist/x/differenceWith.min.js +1 -1
  203. package/dist/x/differenceWith.mjs +1 -1
  204. package/dist/x/filterOut.es.js +1 -1
  205. package/dist/x/filterOut.es.min.js +1 -1
  206. package/dist/x/filterOut.js +1 -1
  207. package/dist/x/filterOut.min.js +1 -1
  208. package/dist/x/filterOut.mjs +1 -1
  209. package/dist/x/find.es.js +1 -1
  210. package/dist/x/find.es.min.js +1 -1
  211. package/dist/x/find.js +1 -1
  212. package/dist/x/find.min.js +1 -1
  213. package/dist/x/find.mjs +1 -1
  214. package/dist/x/findIndex.es.js +1 -1
  215. package/dist/x/findIndex.es.min.js +1 -1
  216. package/dist/x/findIndex.js +1 -1
  217. package/dist/x/findIndex.min.js +1 -1
  218. package/dist/x/findIndex.mjs +1 -1
  219. package/dist/x/first.es.js +1 -1
  220. package/dist/x/first.es.min.js +1 -1
  221. package/dist/x/first.js +1 -1
  222. package/dist/x/first.min.js +1 -1
  223. package/dist/x/first.mjs +1 -1
  224. package/dist/x/flatten.es.js +1 -1
  225. package/dist/x/flatten.es.min.js +1 -1
  226. package/dist/x/flatten.js +1 -1
  227. package/dist/x/flatten.min.js +1 -1
  228. package/dist/x/flatten.mjs +1 -1
  229. package/dist/x/groupBy.es.js +1 -1
  230. package/dist/x/groupBy.es.min.js +1 -1
  231. package/dist/x/groupBy.js +1 -1
  232. package/dist/x/groupBy.min.js +1 -1
  233. package/dist/x/groupBy.mjs +1 -1
  234. package/dist/x/has.es.js +1 -1
  235. package/dist/x/has.es.min.js +1 -1
  236. package/dist/x/has.js +1 -1
  237. package/dist/x/has.min.js +1 -1
  238. package/dist/x/has.mjs +1 -1
  239. package/dist/x/identity.es.js +1 -1
  240. package/dist/x/identity.es.min.js +1 -1
  241. package/dist/x/identity.js +1 -1
  242. package/dist/x/identity.min.js +1 -1
  243. package/dist/x/identity.mjs +1 -1
  244. package/dist/x/includes.es.js +1 -1
  245. package/dist/x/includes.es.min.js +1 -1
  246. package/dist/x/includes.js +1 -1
  247. package/dist/x/includes.min.js +1 -1
  248. package/dist/x/includes.mjs +1 -1
  249. package/dist/x/isDeepEqual.es.js +1 -1
  250. package/dist/x/isDeepEqual.es.min.js +1 -1
  251. package/dist/x/isDeepEqual.js +1 -1
  252. package/dist/x/isDeepEqual.min.js +1 -1
  253. package/dist/x/isDeepEqual.mjs +1 -1
  254. package/dist/x/isEmpty.es.js +1 -1
  255. package/dist/x/isEmpty.es.min.js +1 -1
  256. package/dist/x/isEmpty.js +1 -1
  257. package/dist/x/isEmpty.min.js +1 -1
  258. package/dist/x/isEmpty.mjs +1 -1
  259. package/dist/x/isEqual.es.js +1 -1
  260. package/dist/x/isEqual.es.min.js +1 -1
  261. package/dist/x/isEqual.js +1 -1
  262. package/dist/x/isEqual.min.js +1 -1
  263. package/dist/x/isEqual.mjs +1 -1
  264. package/dist/x/isFunction.es.js +1 -1
  265. package/dist/x/isFunction.es.min.js +1 -1
  266. package/dist/x/isFunction.js +1 -1
  267. package/dist/x/isFunction.min.js +1 -1
  268. package/dist/x/isFunction.mjs +1 -1
  269. package/dist/x/isIn.es.js +1 -1
  270. package/dist/x/isIn.es.min.js +1 -1
  271. package/dist/x/isIn.js +1 -1
  272. package/dist/x/isIn.min.js +1 -1
  273. package/dist/x/isIn.mjs +1 -1
  274. package/dist/x/isObject.es.js +1 -1
  275. package/dist/x/isObject.es.min.js +1 -1
  276. package/dist/x/isObject.js +1 -1
  277. package/dist/x/isObject.min.js +1 -1
  278. package/dist/x/isObject.mjs +1 -1
  279. package/dist/x/isString.es.js +1 -1
  280. package/dist/x/isString.es.min.js +1 -1
  281. package/dist/x/isString.js +1 -1
  282. package/dist/x/isString.min.js +1 -1
  283. package/dist/x/isString.mjs +1 -1
  284. package/dist/x/keys.es.js +1 -1
  285. package/dist/x/keys.es.min.js +1 -1
  286. package/dist/x/keys.js +1 -1
  287. package/dist/x/keys.min.js +1 -1
  288. package/dist/x/keys.mjs +1 -1
  289. package/dist/x/last.es.js +1 -1
  290. package/dist/x/last.es.min.js +1 -1
  291. package/dist/x/last.js +1 -1
  292. package/dist/x/last.min.js +1 -1
  293. package/dist/x/last.mjs +1 -1
  294. package/dist/x/maxBy.es.js +1 -1
  295. package/dist/x/maxBy.es.min.js +1 -1
  296. package/dist/x/maxBy.js +1 -1
  297. package/dist/x/maxBy.min.js +1 -1
  298. package/dist/x/maxBy.mjs +1 -1
  299. package/dist/x/noop.es.js +1 -1
  300. package/dist/x/noop.es.min.js +1 -1
  301. package/dist/x/noop.js +1 -1
  302. package/dist/x/noop.min.js +1 -1
  303. package/dist/x/noop.mjs +1 -1
  304. package/dist/x/pluck.es.js +1 -1
  305. package/dist/x/pluck.es.min.js +1 -1
  306. package/dist/x/pluck.js +1 -1
  307. package/dist/x/pluck.min.js +1 -1
  308. package/dist/x/pluck.mjs +1 -1
  309. package/dist/x/prepend.es.js +1 -1
  310. package/dist/x/prepend.es.min.js +1 -1
  311. package/dist/x/prepend.js +1 -1
  312. package/dist/x/prepend.min.js +1 -1
  313. package/dist/x/prepend.mjs +1 -1
  314. package/dist/x/size.es.js +1 -1
  315. package/dist/x/size.es.min.js +1 -1
  316. package/dist/x/size.js +1 -1
  317. package/dist/x/size.min.js +1 -1
  318. package/dist/x/size.mjs +1 -1
  319. package/dist/x/trace.es.js +1 -1
  320. package/dist/x/trace.es.min.js +1 -1
  321. package/dist/x/trace.js +1 -1
  322. package/dist/x/trace.min.js +1 -1
  323. package/dist/x/trace.mjs +1 -1
  324. package/dist/x/unionWith.es.js +1 -1
  325. package/dist/x/unionWith.es.min.js +1 -1
  326. package/dist/x/unionWith.js +1 -1
  327. package/dist/x/unionWith.min.js +1 -1
  328. package/dist/x/unionWith.mjs +1 -1
  329. package/dist/x/uniq.es.js +1 -1
  330. package/dist/x/uniq.es.min.js +1 -1
  331. package/dist/x/uniq.js +1 -1
  332. package/dist/x/uniq.min.js +1 -1
  333. package/dist/x/uniq.mjs +1 -1
  334. package/dist/x/unless.es.js +1 -1
  335. package/dist/x/unless.es.min.js +1 -1
  336. package/dist/x/unless.js +1 -1
  337. package/dist/x/unless.min.js +1 -1
  338. package/dist/x/unless.mjs +1 -1
  339. package/dist/x/values.es.js +1 -1
  340. package/dist/x/values.es.min.js +1 -1
  341. package/dist/x/values.js +1 -1
  342. package/dist/x/values.min.js +1 -1
  343. package/dist/x/values.mjs +1 -1
  344. package/dist/x/when.es.js +1 -1
  345. package/dist/x/when.es.min.js +1 -1
  346. package/dist/x/when.js +1 -1
  347. package/dist/x/when.min.js +1 -1
  348. package/dist/x/when.mjs +1 -1
  349. package/eq.d.ts +51 -0
  350. package/es.d.ts +80 -0
  351. package/es.js +1 -1
  352. package/every.d.ts +52 -0
  353. package/filter.d.ts +148 -0
  354. package/flatMap.d.ts +109 -0
  355. package/forEach.d.ts +35 -0
  356. package/get.d.ts +70 -0
  357. package/global.d.ts +1 -0
  358. package/gt.d.ts +49 -0
  359. package/gte.d.ts +51 -0
  360. package/index.d.ts +1 -0
  361. package/index.js +1 -1
  362. package/lt.d.ts +49 -0
  363. package/lte.d.ts +49 -0
  364. package/map.d.ts +246 -0
  365. package/monad/Instance.d.ts +246 -0
  366. package/monad/Instance.js +188 -206
  367. package/not.d.ts +34 -0
  368. package/omit.d.ts +50 -0
  369. package/or.d.ts +43 -0
  370. package/package.json +41 -4
  371. package/pick.d.ts +43 -0
  372. package/pipe.d.ts +49 -0
  373. package/reduce.d.ts +166 -0
  374. package/set.d.ts +61 -0
  375. package/some.d.ts +65 -0
  376. package/switchCase.d.ts +76 -0
  377. package/tap.d.ts +53 -0
  378. package/thunkify.d.ts +21 -0
  379. package/transform.d.ts +131 -0
  380. package/tryCatch.d.ts +47 -0
  381. package/x/append.d.ts +38 -0
  382. package/x/callProp.d.ts +20 -0
  383. package/x/defaultsDeep.d.ts +42 -0
  384. package/x/differenceWith.d.ts +25 -0
  385. package/x/filterOut.d.ts +39 -0
  386. package/x/find.d.ts +34 -0
  387. package/x/findIndex.d.ts +25 -0
  388. package/x/first.d.ts +23 -0
  389. package/x/flatten.d.ts +57 -0
  390. package/x/groupBy.d.ts +50 -0
  391. package/x/has.d.ts +25 -0
  392. package/x/heapUsedInLoop.d.ts +53 -0
  393. package/x/identity.d.ts +21 -0
  394. package/x/includes.d.ts +25 -0
  395. package/x/index.d.ts +34 -0
  396. package/x/is.d.ts +2 -0
  397. package/x/isEmpty.d.ts +24 -0
  398. package/x/isEqual.d.ts +2 -0
  399. package/x/isFunction.d.ts +23 -0
  400. package/x/isIn.d.ts +61 -0
  401. package/x/isObject.d.ts +2 -0
  402. package/x/isString.benchmarks.d.ts +1 -0
  403. package/x/isString.d.ts +21 -0
  404. package/x/keys.d.ts +23 -0
  405. package/x/last.d.ts +22 -0
  406. package/x/maxBy.d.ts +41 -0
  407. package/x/noop.d.ts +21 -0
  408. package/x/pluck.d.ts +35 -0
  409. package/x/prepend.d.ts +38 -0
  410. package/x/size.d.ts +21 -0
  411. package/x/test.d.ts +1 -0
  412. package/x/timeInLoop.d.ts +21 -0
  413. package/x/trace.d.ts +30 -0
  414. package/x/tracef.d.ts +7 -0
  415. package/x/unionWith.d.ts +31 -0
  416. package/x/uniq.d.ts +24 -0
  417. package/x/unless.d.ts +28 -0
  418. package/x/values.d.ts +23 -0
  419. package/x/when.d.ts +28 -0
@@ -0,0 +1,10 @@
1
+ export = AggregateReducer;
2
+ /**
3
+ * @name AggregateReducer
4
+ *
5
+ * @synopsis
6
+ * ```coffeescript [specscript]
7
+ * AggregateReducer(reducers Array<reducer function>) -> aggregateReducer function
8
+ * ```
9
+ */
10
+ declare function AggregateReducer(reducers: any): any;
@@ -0,0 +1,231 @@
1
+ /**
2
+ * @name Transducer.map
3
+ *
4
+ * @synopsis
5
+ * ```coffeescript [specscript]
6
+ * type Reducer = (
7
+ * accumulator any,
8
+ * value any,
9
+ * indexOrKey? number|string,
10
+ * collection? Foldable,
11
+ * )=>(nextAccumulator Promise|any)
12
+ *
13
+ * type Transducer = Reducer=>Reducer
14
+ *
15
+ * Transducer.map(mapperFunc function) -> mappingTransducer Transducer
16
+ * ```
17
+ *
18
+ * @description
19
+ * Creates a mapping transducer. Items in the final reducing operation are transformed by the mapper function. It is possible to use an asynchronous mapper, however the reducing operation must support asynchronous execution. This library provides such implementations as [reduce](/docs/reduce) and [transform](/docs/transform).
20
+ *
21
+ * ```javascript [playground]
22
+ * const square = number => number ** 2
23
+ *
24
+ * const concat = (array, item) => array.concat(item)
25
+ *
26
+ * const mapSquare = Transducer.map(square)
27
+ * // mapSquare is a transducer
28
+ *
29
+ * const squareConcatReducer = mapSquare(concat)
30
+ * // now mapSquare is passed the reducer function concat; squareConcatReducer
31
+ * // is a reducer with chained functionality square and concat
32
+ *
33
+ * console.log(
34
+ * reduce([1, 2, 3, 4, 5], squareConcatReducer, [])
35
+ * ) // [1, 4, 9, 16, 25]
36
+ *
37
+ * // the same squareConcatReducer is consumable with vanilla JavaScript
38
+ * console.log(
39
+ * [1, 2, 3, 4, 5].reduce(squareConcatReducer, [])
40
+ * ) // [1, 4, 9, 16, 25]
41
+ *
42
+ * // concat is implicit when transforming into arrays
43
+ * console.log(
44
+ * transform([1, 2, 3, 4, 5], Transducer.map(square), [])
45
+ * ) // [1, 4, 9, 16, 25]
46
+ * ```
47
+ *
48
+ * Read more on transducers [here](/blog/transducers-crash-course-rubico-v2).
49
+ */
50
+ export function map(mapper: any): (arg0: any) => any;
51
+ /**
52
+ * @name Transducer.filter
53
+ *
54
+ * @synopsis
55
+ * ```coffeescript [specscript]
56
+ * type Reducer = (
57
+ * accumulator any,
58
+ * value any,
59
+ * indexOrKey? number|string,
60
+ * collection? Foldable,
61
+ * )=>(nextAccumulator Promise|any)
62
+ *
63
+ * type Transducer = Reducer=>Reducer
64
+ *
65
+ * Transducer.filter(predicate function) -> filteringTransducer Transducer
66
+ * ```
67
+ *
68
+ * @description
69
+ * Creates a filtering transducer. A filtering reducer skips items of reducing operation if they test falsy by the predicate. It is possible to use an asynchronous predicate, however the reducing operation must support asynchronous execution. This library provides such implementations as [reduce](/docs/reduce) and [transform](/docs/transform).
70
+ *
71
+ * ```javascript [playground]
72
+ * const isOdd = number => number % 2 == 1
73
+ *
74
+ * const concat = (array, item) => array.concat(item)
75
+ *
76
+ * const concatOddNumbers = filter(isOdd)(concat)
77
+ *
78
+ * console.log(
79
+ * [1, 2, 3, 4, 5].reduce(concatOddNumbers, []),
80
+ * ) // [1, 3, 5]
81
+ * ```
82
+ */
83
+ export function filter(predicate: any): (arg0: any) => any;
84
+ /**
85
+ * @name Transducer.flatMap
86
+ *
87
+ * @synopsis
88
+ * ```coffeescript [specscript]
89
+ * type Reducer = (
90
+ * accumulator any,
91
+ * value any,
92
+ * indexOrKey? number|string,
93
+ * collection? Foldable,
94
+ * )=>(nextAccumulator Promise|any)
95
+ *
96
+ * type Transducer = Reducer=>Reducer
97
+ *
98
+ * Transducer.flatMap(flatMapper) -> flatMappingTransducer Transducer
99
+ * ```
100
+ *
101
+ * @description
102
+ * Creates a flatMapping transducer. A flatMapping transducer applies the flatMapping function to each item of the reducing operation, concatenating the results of the flatMapper execution into the final result. It is possible to use an asynchronous flatMapper, however the reducing operation must support asynchronous execution. This library provides such implementations as [reduce](/docs/reduce) and [transform](/docs/transform).
103
+ *
104
+ * ```javascript [playground]
105
+ * const powers = number => [number, number ** 2, number ** 3]
106
+ *
107
+ * const numbers = [1, 2, 3, 4, 5]
108
+ *
109
+ * console.log(
110
+ * transform(numbers, Transducer.flatMap(powers), [])
111
+ * ) // [1, 1, 1, 2, 4, 8, 3, 9, 27, 4, 16, 64, 5, 25, 125]
112
+ * ```
113
+ *
114
+ * Read more on transducers [here](/blog/transducers-crash-course-rubico-v2).
115
+ */
116
+ export function flatMap(flatMapper: any): (arg0: any) => any;
117
+ /**
118
+ * @name Transducer.forEach
119
+ *
120
+ * @synopsis
121
+ * ```coffeescript [specscript]
122
+ * type Reducer = (
123
+ * accumulator any,
124
+ * value any,
125
+ * indexOrKey? number|string,
126
+ * collection? Foldable,
127
+ * )=>(nextAccumulator Promise|any)
128
+ *
129
+ * type Transducer = Reducer=>Reducer
130
+ *
131
+ * Transducer.forEach(func function) -> forEachTransducer Transducer
132
+ * ```
133
+ *
134
+ * @description
135
+ * Creates an effectful pasthrough transducer. The effectful passthrough transducer applies the effectful function to each item of the reducing operation, leaving the reducing operation unchanged. It is possible to use an asynchronous effectful function, however the reducing operation must support asynchronous execution. This library provides such implementations as [reduce](/docs/reduce) and [transform](/docs/transform).
136
+ *
137
+ * ```javascript [playground]
138
+ * const numbers = [1, 2, 3, 4, 5]
139
+ * transform(numbers, compose([
140
+ * Transducer.map(number => number ** 2),
141
+ * Transducer.forEach(console.log), // 1 4 9 16 25
142
+ * ]), null)
143
+ * ```
144
+ */
145
+ export function forEach(func: any): (arg0: any) => any;
146
+ /**
147
+ * @name Transducer.passthrough
148
+ *
149
+ * @synopsis
150
+ * ```coffeescript [specscript]
151
+ * type Reducer = (
152
+ * accumulator any,
153
+ * value any,
154
+ * indexOrKey? number|string,
155
+ * collection? Foldable,
156
+ * )=>(nextAccumulator Promise|any)
157
+ *
158
+ * type Transducer = Reducer=>Reducer
159
+ *
160
+ * Transducer.passthrough(func function) -> passthroughTransducer Transducer
161
+ * ```
162
+ *
163
+ * @description
164
+ * Creates a pasthrough transducer. The passthrough transducer passes each item of the reducing operation through, leaving the reducing operation unchanged.
165
+ *
166
+ * ```javascript [playground]
167
+ * const createAsyncNumbers = async function* () {
168
+ * let number = 0
169
+ * while (number < 10) {
170
+ * yield number
171
+ * number += 1
172
+ * }
173
+ * }
174
+ *
175
+ * transform(createAsyncNumbers(), Transducer.passthrough, [])
176
+ * .then(console.log) // [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
177
+ * ```
178
+ */
179
+ export function passthrough(reducer: any): any;
180
+ /**
181
+ * @name Transducer.tryCatch
182
+ *
183
+ * @synopsis
184
+ * ```coffeescript [specscript]
185
+ * type Reducer = (
186
+ * accumulator any,
187
+ * item any,
188
+ * indexOrKey? number|string,
189
+ * collection? Foldable,
190
+ * )=>(nextAccumulator Promise|any)
191
+ *
192
+ * type Transducer = Reducer=>Reducer
193
+ *
194
+ * Transducer.tryCatch(
195
+ * transducerTryer Transducer,
196
+ * catcher (error Error, item any)=>Promise|any,
197
+ * ) -> tryCatchTransducer Transducer
198
+ * ```
199
+ *
200
+ * @description
201
+ * Creates an error handling transducer. The error handling transducer wraps a transducer and catches any errors thrown by the transducer with the catcher function. The catcher function is provided the error as well as the original item (before any processing by the transducer) for which the error was thrown. It is possible for either the transducer or the catcher to be asynchronous, however the reducing operation must support asynchronous execution. This library provides such implementations as [reduce](/docs/reduce) and [transform](/docs/transform).
202
+ *
203
+ * ```javascript [playground]
204
+ * const db = new Map()
205
+ * db.set('a', { id: 'a', name: 'George' })
206
+ * db.set('b', { id: 'b', name: 'Jane' })
207
+ * db.set('c', { id: 'c', name: 'Jill' })
208
+ * db.set('e', { id: 'e', name: 'Jim' })
209
+ *
210
+ * const userIds = ['a', 'b', 'c', 'd', 'e']
211
+ *
212
+ * transform(userIds, Transducer.tryCatch(compose([
213
+ * Transducer.map(async userId => {
214
+ * if (db.has(userId)) {
215
+ * return db.get(userId)
216
+ * }
217
+ * throw new Error(`user ${userId} not found`)
218
+ * }),
219
+ *
220
+ * Transducer.forEach(user => {
221
+ * console.log('Found', user.name)
222
+ * })
223
+ * ]), (error, userId) => {
224
+ * console.error(error)
225
+ * console.log('userId in catcher:', userId)
226
+ * // original userId for which the error was thrown is provided
227
+ * }), null)
228
+ * ```
229
+
230
+ */
231
+ export function tryCatch(transducerTryer: any, catcher: any): (arg0: any) => any;
package/__.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export = __;
2
+ import __ = require("./_internal/placeholder");
@@ -0,0 +1,2 @@
1
+ export = EmptyMap;
2
+ declare function EmptyMap(): any;
@@ -0,0 +1,15 @@
1
+ export = arrayFind;
2
+ /**
3
+ * @name arrayFind
4
+ *
5
+ * @synopsis
6
+ * ```coffeescript [specscript]
7
+ * var T any,
8
+ * array Array<T>,
9
+ * predicate T=>Promise|boolean,
10
+ * result Promise|T|undefined
11
+ *
12
+ * arrayFind(array, predicate) -> result
13
+ * ```
14
+ */
15
+ declare function arrayFind(array: any, predicate: any): any;
@@ -0,0 +1,12 @@
1
+ export = asyncIteratorFind;
2
+ /**
3
+ * @name asyncIteratorFind
4
+ *
5
+ * @synopsis
6
+ * var T any,
7
+ * asyncIterator AsyncIterator<T>,
8
+ * predicate T=>Promise|boolean
9
+ *
10
+ * asyncIteratorFind(asyncIterator, predicate) -> Promise|T|undefined
11
+ */
12
+ declare function asyncIteratorFind(asyncIterator: any, predicate: any): Promise<any>;
@@ -0,0 +1,12 @@
1
+ export = iteratorFind;
2
+ /**
3
+ * @name iteratorFind
4
+ *
5
+ * @synopsis
6
+ * var T any,
7
+ * iterator Iterator<T>,
8
+ * predicate T=>Promise|boolean
9
+ *
10
+ * iteratorFind(iterator, predicate) -> Promise|T|undefined
11
+ */
12
+ declare function iteratorFind(iterator: any, predicate: any): any;
@@ -0,0 +1,20 @@
1
+ export = thunkify5;
2
+ /**
3
+ * @name thunkify5
4
+ *
5
+ * @synopsis
6
+ * ```coffeescript [specscript]
7
+ * thunkify5<
8
+ * arg0 any,
9
+ * arg1 any,
10
+ * arg2 any,
11
+ * arg3 any,
12
+ * arg4 any,
13
+ * func (arg0, arg1, arg2, arg3, arg4)=>any,
14
+ * >(func, arg0, arg1, arg2, arg3, arg4) -> thunk ()=>func(arg0, arg1, arg2, arg3, arg4)
15
+ * ```
16
+ *
17
+ * @description
18
+ * Create a thunk from a function and five arguments.
19
+ */
20
+ declare function thunkify5(func: any, arg0: any, arg1: any, arg2: any, arg3: any, arg4: any): () => any;
@@ -0,0 +1,25 @@
1
+ export = timeInLoop;
2
+ /**
3
+ * @name timeInLoop
4
+ *
5
+ * @synopsis
6
+ * ```coffeescript [specscript]
7
+ * timeInLoop(description string, loopCount number, fn function, options? {
8
+ * silent?: boolean,
9
+ * }) -> undefined
10
+ * ```
11
+ *
12
+ * @description
13
+ * Logs the amount of time required for a function to run a certain number of times
14
+ *
15
+ * ```js
16
+ * timeInLoop('hello', 1e6, () => 'hello') // hello: 1e+6: 3.474ms
17
+ * ```
18
+ *
19
+ * Reference: https://gist.github.com/funfunction/91b5876a5f562e1e352aed0fcabc3858
20
+ */
21
+ declare function timeInLoop(description: any, loopCount: any, fn: any, options?: {}): {
22
+ description: any;
23
+ loopCount: any;
24
+ duration: number;
25
+ };
@@ -0,0 +1,23 @@
1
+ export = timeInLoopAsync;
2
+ /**
3
+ * @name timeInLoopAsync
4
+ *
5
+ * @synopsis
6
+ * ```coffeescript [specscript]
7
+ * timeInLoop.async(description string, loopCount number, fn function, options? {
8
+ * silent?: boolean,
9
+ * }) -> undefined
10
+ * ```
11
+ *
12
+ * @description
13
+ * Like timeInLoop, but every call is awaited
14
+ *
15
+ * ```js
16
+ * timeInLoop.async('async hello', 1e6, async () => 'hello') // async hello: 1e+6: 116.006ms
17
+ * ```
18
+ */
19
+ declare function timeInLoopAsync(description: any, loopCount: any, fn: any, options?: {}): Promise<{
20
+ description: any;
21
+ loopCount: any;
22
+ duration: number;
23
+ }>;
package/all.d.ts ADDED
@@ -0,0 +1,100 @@
1
+ export = all;
2
+ /**
3
+ * @name all
4
+ *
5
+ * @synopsis
6
+ * ```coffeescript [specscript]
7
+ * all(...args, funcsArray Array<function>) -> result Promise|Array
8
+ *
9
+ * all(funcsArray Array<function>)(...args) -> result Promise|Array
10
+ *
11
+ * all(...args, funcsObject Object<function>) -> result Promise|Object
12
+ *
13
+ * all(funcsObject Object<function>)(...args) -> result Promise|Object
14
+ * ```
15
+ *
16
+ * @description
17
+ * Function executor and composer. Accepts either an array of functions or an object of functions as the values. Calls each function of the provided array or object in parallel with the provided arguments. Returns either an array or object of the results of the function executions.
18
+ *
19
+ * ```javascript [playground]
20
+ * const createArrayOfGreetingsFor = all([
21
+ * name => `Hi ${name}`,
22
+ * name => `Hey ${name}`,
23
+ * name => `Hello ${name}`,
24
+ * ])
25
+ *
26
+ * const arrayOfGreetingsForFred = createArrayOfGreetingsFor('Fred')
27
+ *
28
+ * console.log(arrayOfGreetingsForFred)
29
+ * // ['Hi Fred', 'Hey Fred', 'Hello Fred']
30
+ *
31
+ * const createObjectOfGreetingsFor = all({
32
+ * hi: name => `Hi ${name}`,
33
+ * hey: name => `Hey ${name}`,
34
+ * hello: name => `Hello ${name}`,
35
+ * })
36
+ *
37
+ * const objectOfGreetingsForJane = createObjectOfGreetingsFor('Jane')
38
+ *
39
+ * console.log(objectOfGreetingsForJane)
40
+ * // { hi: 'Hi Jane', hey: 'Hey Jane', hello: 'Hello Jane' }
41
+ * ```
42
+ *
43
+ * `all` can simultaneously compose objects and handle promises.
44
+ *
45
+ * ```javascript [playground]
46
+ * const identity = value => value
47
+ *
48
+ * const userbase = new Map()
49
+ * userbase.set('1', { _id: 1, name: 'George' })
50
+ *
51
+ * const getUserByID = async id => userbase.get(id)
52
+ *
53
+ * const getAndLogUserById = pipe([
54
+ * all({
55
+ * id: identity,
56
+ * user: getUserByID,
57
+ * }),
58
+ * tap(({ id, user }) => {
59
+ * console.log(`Got user ${JSON.stringify(user)} by id ${id}`)
60
+ * }),
61
+ * ])
62
+ *
63
+ * getAndLogUserById('1') // Got user {"_id":1,"name":"George"} by id 1
64
+ * ```
65
+ *
66
+ * @execution concurrent
67
+ */
68
+ declare function all(...args: any[]): any;
69
+ declare namespace all {
70
+ /**
71
+ * @name all.series
72
+ *
73
+ * @synopsis
74
+ * ```coffeescript [specscript]
75
+ * all.series(...args, funcsArray Array<function>) -> result Promise|Array
76
+ *
77
+ * all.series(funcsArray Array<function>)(...args) -> result Promise|Array
78
+ * ```
79
+ *
80
+ * @description
81
+ * `all` with serial execution.
82
+ *
83
+ * ```javascript [playground]
84
+ * const sleep = ms => () => new Promise(resolve => setTimeout(resolve, ms))
85
+ *
86
+ * all.series([
87
+ * greeting => console.log(greeting + ' world'),
88
+ * sleep(1000),
89
+ * greeting => console.log(greeting + ' mom'),
90
+ * sleep(1000),
91
+ * greeting => console.log(greeting + ' goodbye'),
92
+ * ])('hello') // hello world
93
+ * // hello mom
94
+ * // hello goodbye
95
+ * ```
96
+ *
97
+ * @execution series
98
+ */
99
+ function series(...args: any[]): any;
100
+ }
package/always.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export = always;
2
+ import always = require("./_internal/always");
package/and.d.ts ADDED
@@ -0,0 +1,45 @@
1
+ export = and;
2
+ /**
3
+ * @name and
4
+ *
5
+ * @synopsis
6
+ * ```coffeescript [specscript]
7
+ * and(values Array<boolean>) -> result boolean
8
+ *
9
+ * and(...args, predicatesOrValues Array<function|boolean>) -> Promise|boolean
10
+ *
11
+ * and(predicatesOrValues Array<function|boolean>)(...args) -> Promise|boolean
12
+ * ```
13
+ *
14
+ * @description
15
+ * Tests an array of boolean values, returning true if all boolean values are truthy.
16
+ *
17
+ * ```javascript [playground]
18
+ * const oneIsLessThanThree = 1 < 3
19
+ * const twoIsGreaterThanOne = 2 > 1
20
+ * const threeIsEqualToThree = 3 === 3
21
+ *
22
+ * console.log(
23
+ * and([oneIsLessThanThree, twoIsGreaterThanOne, threeIsEqualToThree]),
24
+ * ) // true
25
+ * ```
26
+ *
27
+ * If any values in the array are synchronous or asynchronous predicate functions, `and` takes another argument to test concurrently against the predicate functions, returning true if all array values and resolved values from the predicates are truthy.
28
+ *
29
+ * ```javascript [playground]
30
+ * const isOdd = number => number % 2 == 1
31
+ *
32
+ * const isPositive = number => number > 0
33
+ *
34
+ * const isLessThan3 = number => number < 3
35
+ *
36
+ * console.log(
37
+ * and([isOdd, isPositive, isLessThan3])(1),
38
+ * ) // true
39
+ * ```
40
+ *
41
+ * @execution series
42
+ *
43
+ * @note ...args slows down here by an order of magnitude
44
+ */
45
+ declare function and(...args: any[]): any;
package/assign.d.ts ADDED
@@ -0,0 +1,46 @@
1
+ export = assign;
2
+ /**
3
+ * @name assign
4
+ *
5
+ * @synopsis
6
+ * ```coffeescript [specscript]
7
+ * assign(object Object, resolvers Object<function>) -> result Promise|Object
8
+ *
9
+ * assign(resolvers Object<function>)(object Object) -> result Promise|Object
10
+ * ```
11
+ *
12
+ * @description
13
+ * Function executor and composer. Accepts an object of resolver functions and an argument object. Creates a result object from the argument object, evaluates each resolver with the argument object, and assigns to the result object the evaluations at the corresponding resolver keys.
14
+ *
15
+ * ```javascript [playground]
16
+ * const assignSquaredAndCubed = assign({
17
+ * squared: ({ number }) => number ** 2,
18
+ * cubed: ({ number }) => number ** 3,
19
+ * })
20
+ *
21
+ * console.log(assignSquaredAndCubed({ number: 2 }))
22
+ * // { number: 2, squared: 4, cubed: 8 }
23
+ *
24
+ * console.log(assignSquaredAndCubed({ number: 3 }))
25
+ * // { number: 3, squared: 9, cubed: 27 }
26
+ * ```
27
+ *
28
+ * Any of the resolvers may be asynchronous and return Promises.
29
+ *
30
+ * ```javascript [playground]
31
+ * const sleep = ms => new Promise(resolve => setTimeout(resolve, ms))
32
+ *
33
+ * const asyncAssignTotal = assign({
34
+ * async total({ numbers }) {
35
+ * await sleep(500)
36
+ * return numbers.reduce((a, b) => a + b)
37
+ * },
38
+ * })
39
+ *
40
+ * asyncAssignTotal({ numbers: [1, 2, 3, 4, 5] }).then(console.log)
41
+ * // { numbers: [1, 2, 3, 4, 5], total: 15 }
42
+ * ```
43
+ *
44
+ * @execution concurrent
45
+ */
46
+ declare function assign(arg0: any, arg1: any): any;
package/compose.d.ts ADDED
@@ -0,0 +1,25 @@
1
+ export = compose;
2
+ /**
3
+ * @name compose
4
+ *
5
+ * @synopsis
6
+ * ```coffeescript [specscript]
7
+ * compose(funcs Array<function>)(...args) -> result Promise|any
8
+ *
9
+ * compose(...args, funcs Array<function>) -> result Promise|any
10
+ * ```
11
+ *
12
+ * @description
13
+ * Creates a function composition from an array of functions, where each function passes its return value as a single argument to the previous function until all functions have executed. The last function is called with the arguments to the composition, while the result of a function composition is the return value of its first function. If any function of the composition is asynchronous, the result of the execution is a Promise. `compose` is effectively `pipe` in reverse.
14
+ *
15
+ * ```javascript [playground]
16
+ * const f = number => number * 2
17
+ *
18
+ * const g = number => number + 3
19
+ *
20
+ * console.log(
21
+ * compose(5, [f, g]),
22
+ * ) // 16
23
+ * ```
24
+ */
25
+ declare function compose(...args: any[]): any;
package/curry.d.ts ADDED
@@ -0,0 +1,70 @@
1
+ export = curry;
2
+ /**
3
+ * @name curry
4
+ *
5
+ * @synopsis
6
+ * ```coffeescript [specscript]
7
+ * type __ = Symbol(placeholder)
8
+ * type ArgsWithPlaceholder = Array<__|any>
9
+ *
10
+ * args ArgsWithPlaceholder
11
+ * moreArgs ArgsWithPlaceholder
12
+ *
13
+ * curry(
14
+ * func function,
15
+ * ...args
16
+ * ) -> curriedFuncOrResult function|any
17
+ *
18
+ * curriedFuncOrResult(...moreArgs) -> anotherCurriedFuncOrResult function|any
19
+ * ```
20
+ *
21
+ * @description
22
+ * Enable partial application of a function's arguments in any order. Provide the placeholder value `__` to specify an argument to be resolved in the partially applied function.
23
+ *
24
+ * ```javascript [playground]
25
+ * const add = (a, b, c) => a + b + c
26
+ *
27
+ * console.log(curry(add, 'a', 'b', 'c')) // 'abc'
28
+ * console.log(curry(add)('a', 'b', 'c')) // 'abc'
29
+ * console.log(curry(add, 'a')('b', 'c')) // 'abc'
30
+ * console.log(curry(add, 'a', 'b')('c')) // 'abc'
31
+ * console.log(curry(add)('a')('b')('c')) // 'abc'
32
+ *
33
+ * console.log(curry(add, __, 'b', 'c')('a')) // abc
34
+ * console.log(curry(add, __, __, 'c')('a', 'b')) // abc
35
+ * console.log(curry(add, __, __, 'c')(__, 'b')('a')) // abc
36
+ * ```
37
+ */
38
+ declare function curry(func: any, ...args: any[]): any;
39
+ declare namespace curry {
40
+ /**
41
+ * @name curry.arity
42
+ *
43
+ * @synopsis
44
+ * ```coffeescript [specscript]
45
+ * type __ = Symbol(placeholder)
46
+ * type ArgsWithPlaceholder = Array<__|any>
47
+ *
48
+ * args ArgsWithPlaceholder
49
+ * moreArgs ArgsWithPlaceholder
50
+ *
51
+ * curry.arity(
52
+ * arity number,
53
+ * func function,
54
+ * ...args
55
+ * ) -> curriedFuncOrResult function|any
56
+ *
57
+ * curriedFuncOrResult(...moreArgs) -> anotherCurriedFuncOrResult function|any
58
+ * ```
59
+ *
60
+ * @description
61
+ * `curry` with specified arity (number of arguments taken by the function) as the first parameter.
62
+ *
63
+ * ```javascript [playground]
64
+ * const add = (a, b, c = 0) => a + b + c
65
+ *
66
+ * console.log(curry.arity(2, add, 1, 2)) // 3
67
+ * ```
68
+ */
69
+ function arity(arity: any, func: any, ...args: any[]): any;
70
+ }
@@ -1,5 +1,5 @@
1
1
  /**
2
- * rubico v2.3.0
2
+ * rubico v2.3.1
3
3
  * https://github.com/a-synchronous/rubico
4
4
  * (c) 2019-2023 Richard Tong
5
5
  * rubico may be freely distributed under the MIT license.
@@ -1,5 +1,5 @@
1
1
  /**
2
- * rubico v2.3.0
2
+ * rubico v2.3.1
3
3
  * https://github.com/a-synchronous/rubico
4
4
  * (c) 2019-2023 Richard Tong
5
5
  * rubico may be freely distributed under the MIT license.
@@ -1,5 +1,5 @@
1
1
  /**
2
- * rubico v2.3.0
2
+ * rubico v2.3.1
3
3
  * https://github.com/a-synchronous/rubico
4
4
  * (c) 2019-2023 Richard Tong
5
5
  * rubico may be freely distributed under the MIT license.
@@ -1,5 +1,5 @@
1
1
  /**
2
- * rubico v2.3.0
2
+ * rubico v2.3.1
3
3
  * https://github.com/a-synchronous/rubico
4
4
  * (c) 2019-2023 Richard Tong
5
5
  * rubico may be freely distributed under the MIT license.