@stdlib/utils-async 0.0.3 → 0.0.7

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 (4) hide show
  1. package/NOTICE +1 -1
  2. package/README.md +73 -45
  3. package/package.json +3 -2
  4. package/CHANGELOG.md +0 -5
package/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2021 The Stdlib Authors.
1
+ Copyright (c) 2016-2022 The Stdlib Authors.
package/README.md CHANGED
@@ -20,9 +20,9 @@ limitations under the License.
20
20
 
21
21
  # Async
22
22
 
23
- [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
23
+ [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
24
24
 
25
- > Standard library async utilities.
25
+ > Async utilities.
26
26
 
27
27
  <section class="installation">
28
28
 
@@ -44,7 +44,7 @@ var ns = require( '@stdlib/utils-async' );
44
44
 
45
45
  #### ns
46
46
 
47
- Standard library async utilities.
47
+ Namespace containing async utilities.
48
48
 
49
49
  ```javascript
50
50
  var o = ns;
@@ -55,37 +55,37 @@ var o = ns;
55
55
 
56
56
  <div class="namespace-toc">
57
57
 
58
- - <span class="signature">[`anyByAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/any-by]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a collection passes a test implemented by a predicate function.</span>
59
58
  - <span class="signature">[`anyByRightAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/any-by-right]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a collection passes a test implemented by a predicate function, iterating from right to left.</span>
59
+ - <span class="signature">[`anyByAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/any-by]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a collection passes a test implemented by a predicate function.</span>
60
60
  - <span class="signature">[`bifurcateByAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/bifurcate-by]</span><span class="delimiter">: </span><span class="description">split values into two groups according to a predicate function.</span>
61
61
  - <span class="signature">[`composeAsync( ...fcn )`][@stdlib/utils/async/compose]</span><span class="delimiter">: </span><span class="description">function composition.</span>
62
62
  - <span class="signature">[`countByAsync( collection, [options,] indicator, done )`][@stdlib/utils/async/count-by]</span><span class="delimiter">: </span><span class="description">group values according to an indicator function and return group counts.</span>
63
63
  - <span class="signature">[`doUntilAsync( fcn, predicate, done[, thisArg ] )`][@stdlib/utils/async/do-until]</span><span class="delimiter">: </span><span class="description">invoke a function until a test condition is true.</span>
64
64
  - <span class="signature">[`doWhileAsync( fcn, predicate, done[, thisArg ] )`][@stdlib/utils/async/do-while]</span><span class="delimiter">: </span><span class="description">invoke a function while a test condition is true.</span>
65
- - <span class="signature">[`everyByAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/every-by]</span><span class="delimiter">: </span><span class="description">test whether all elements in a collection pass a test implemented by a predicate function.</span>
66
65
  - <span class="signature">[`everyByRightAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/every-by-right]</span><span class="delimiter">: </span><span class="description">test whether all elements in a collection pass a test implemented by a predicate function, iterating from right to left.</span>
67
- - <span class="signature">[`forEachAsync( collection, [options,] fcn, done )`][@stdlib/utils/async/for-each]</span><span class="delimiter">: </span><span class="description">invoke a function once for each element in a collection.</span>
66
+ - <span class="signature">[`everyByAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/every-by]</span><span class="delimiter">: </span><span class="description">test whether all elements in a collection pass a test implemented by a predicate function.</span>
68
67
  - <span class="signature">[`forEachRightAsync( collection, [options,] fcn, done )`][@stdlib/utils/async/for-each-right]</span><span class="delimiter">: </span><span class="description">invoke a function once for each element in a collection, iterating from right to left.</span>
68
+ - <span class="signature">[`forEachAsync( collection, [options,] fcn, done )`][@stdlib/utils/async/for-each]</span><span class="delimiter">: </span><span class="description">invoke a function once for each element in a collection.</span>
69
69
  - <span class="signature">[`functionSequenceAsync( ...fcn )`][@stdlib/utils/async/function-sequence]</span><span class="delimiter">: </span><span class="description">function sequence.</span>
70
70
  - <span class="signature">[`groupByAsync( collection, [options,] indicator, done )`][@stdlib/utils/async/group-by]</span><span class="delimiter">: </span><span class="description">group values according to an indicator function.</span>
71
71
  - <span class="signature">[`ifelseAsync( predicate, x, y, done )`][@stdlib/utils/async/if-else]</span><span class="delimiter">: </span><span class="description">if a predicate function returns a truthy value, return `x`; otherwise, return `y`.</span>
72
72
  - <span class="signature">[`ifthenAsync( predicate, x, y, done )`][@stdlib/utils/async/if-then]</span><span class="delimiter">: </span><span class="description">if a predicate function returns a truthy value, invoke `x`; otherwise, invoke `y`.</span>
73
- - <span class="signature">[`inmapAsync( collection, [options,] fcn, done )`][@stdlib/utils/async/inmap]</span><span class="delimiter">: </span><span class="description">invoke a function for each element in a collection and update the collection in-place.</span>
74
73
  - <span class="signature">[`inmapRightAsync( collection, [options,] fcn, done )`][@stdlib/utils/async/inmap-right]</span><span class="delimiter">: </span><span class="description">invoke a function for each element in a collection and update the collection in-place, iterating from right to left.</span>
74
+ - <span class="signature">[`inmapAsync( collection, [options,] fcn, done )`][@stdlib/utils/async/inmap]</span><span class="delimiter">: </span><span class="description">invoke a function for each element in a collection and update the collection in-place.</span>
75
75
  - <span class="signature">[`mapFunAsync( fcn, n, [options,] done )`][@stdlib/utils/async/map-function]</span><span class="delimiter">: </span><span class="description">invoke a function `n` times and return an array of accumulated function return values.</span>
76
76
  - <span class="signature">[`mapKeysAsync( obj, [options,] transform, done )`][@stdlib/utils/async/map-keys]</span><span class="delimiter">: </span><span class="description">map keys from one object to a new object having the same values.</span>
77
77
  - <span class="signature">[`mapValuesAsync( obj, [options,] transform, done )`][@stdlib/utils/async/map-values]</span><span class="delimiter">: </span><span class="description">map values from one object to a new object having the same keys.</span>
78
- - <span class="signature">[`noneByAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/none-by]</span><span class="delimiter">: </span><span class="description">test whether all elements in a collection fail a test implemented by a predicate function.</span>
79
78
  - <span class="signature">[`noneByRightAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/none-by-right]</span><span class="delimiter">: </span><span class="description">test whether all elements in a collection fail a test implemented by a predicate function, iterating from right to left.</span>
80
- - <span class="signature">[`reduceAsync( collection, initial, [options,] reducer, done )`][@stdlib/utils/async/reduce]</span><span class="delimiter">: </span><span class="description">apply a function against an accumulator and each element in a collection and return the accumulated result.</span>
79
+ - <span class="signature">[`noneByAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/none-by]</span><span class="delimiter">: </span><span class="description">test whether all elements in a collection fail a test implemented by a predicate function.</span>
81
80
  - <span class="signature">[`reduceRightAsync( collection, initial, [options,] reducer, done )`][@stdlib/utils/async/reduce-right]</span><span class="delimiter">: </span><span class="description">apply a function against an accumulator and each element in a collection and return the accumulated result, iterating from right to left.</span>
82
- - <span class="signature">[`someByAsync( collection, n, [options,] predicate, done )`][@stdlib/utils/async/some-by]</span><span class="delimiter">: </span><span class="description">test whether a collection contains at least `n` elements which pass a test implemented by a predicate function.</span>
81
+ - <span class="signature">[`reduceAsync( collection, initial, [options,] reducer, done )`][@stdlib/utils/async/reduce]</span><span class="delimiter">: </span><span class="description">apply a function against an accumulator and each element in a collection and return the accumulated result.</span>
82
+ - <span class="signature">[`waterfall( fcns, clbk[, thisArg] )`][@stdlib/utils/async/series-waterfall]</span><span class="delimiter">: </span><span class="description">execute functions in series, passing the results of one function as arguments to the next function.</span>
83
83
  - <span class="signature">[`someByRightAsync( collection, n, [options,] predicate, done )`][@stdlib/utils/async/some-by-right]</span><span class="delimiter">: </span><span class="description">test whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.</span>
84
+ - <span class="signature">[`someByAsync( collection, n, [options,] predicate, done )`][@stdlib/utils/async/some-by]</span><span class="delimiter">: </span><span class="description">test whether a collection contains at least `n` elements which pass a test implemented by a predicate function.</span>
84
85
  - <span class="signature">[`tabulateByAsync( collection, [options,] indicator, done )`][@stdlib/utils/async/tabulate-by]</span><span class="delimiter">: </span><span class="description">generate a frequency table according to an indicator function.</span>
85
86
  - <span class="signature">[`trycatchAsync( x, y, done )`][@stdlib/utils/async/try-catch]</span><span class="delimiter">: </span><span class="description">if a function does not return an error, invoke a callback with the function result; otherwise, invoke a callback with a value `y`.</span>
86
87
  - <span class="signature">[`trythenAsync( x, y, done )`][@stdlib/utils/async/try-then]</span><span class="delimiter">: </span><span class="description">if a function does not return an error, invoke a callback with the function result; otherwise, invoke a second function.</span>
87
88
  - <span class="signature">[`untilAsync( predicate, fcn, done[, thisArg ] )`][@stdlib/utils/async/until]</span><span class="delimiter">: </span><span class="description">invoke a function until a test condition is true.</span>
88
- - <span class="signature">[`waterfall( fcns, clbk[, thisArg] )`][@stdlib/utils/async/series-waterfall]</span><span class="delimiter">: </span><span class="description">execute functions in series, passing the results of one function as arguments to the next function.</span>
89
89
  - <span class="signature">[`whileAsync( predicate, fcn, done[, thisArg ] )`][@stdlib/utils/async/while]</span><span class="delimiter">: </span><span class="description">invoke a function while a test condition is true.</span>
90
90
 
91
91
  </div>
@@ -115,6 +115,16 @@ console.log( objectKeys( ns ) );
115
115
 
116
116
  <!-- /.examples -->
117
117
 
118
+ <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
119
+
120
+ <section class="related">
121
+
122
+ </section>
123
+
124
+ <!-- /.related -->
125
+
126
+ <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
127
+
118
128
 
119
129
  <section class="main-repo" >
120
130
 
@@ -126,6 +136,10 @@ This package is part of [stdlib][stdlib], a standard library for JavaScript and
126
136
 
127
137
  For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
128
138
 
139
+ #### Community
140
+
141
+ [![Chat][chat-image]][chat-url]
142
+
129
143
  ---
130
144
 
131
145
  ## License
@@ -135,7 +149,7 @@ See [LICENSE][stdlib-license].
135
149
 
136
150
  ## Copyright
137
151
 
138
- Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
152
+ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
139
153
 
140
154
  </section>
141
155
 
@@ -154,9 +168,23 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
154
168
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-async/main.svg
155
169
  [coverage-url]: https://codecov.io/github/stdlib-js/utils-async?branch=main
156
170
 
157
- [dependencies-image]: https://img.shields.io/david/stdlib-js/utils-async
171
+ <!--
172
+
173
+ [dependencies-image]: https://img.shields.io/david/stdlib-js/utils-async.svg
158
174
  [dependencies-url]: https://david-dm.org/stdlib-js/utils-async/main
159
175
 
176
+ -->
177
+
178
+ [umd]: https://github.com/umdjs/umd
179
+ [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
180
+
181
+ [deno-url]: https://github.com/stdlib-js/utils-async/tree/deno
182
+ [umd-url]: https://github.com/stdlib-js/utils-async/tree/umd
183
+ [esm-url]: https://github.com/stdlib-js/utils-async/tree/esm
184
+
185
+ [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
186
+ [chat-url]: https://gitter.im/stdlib-js/stdlib/
187
+
160
188
  [stdlib]: https://github.com/stdlib-js/stdlib
161
189
 
162
190
  [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
@@ -165,69 +193,69 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
165
193
 
166
194
  <!-- <toc-links> -->
167
195
 
168
- [@stdlib/utils/async/if-else]: https://github.com/stdlib-js/utils-async-if-else
196
+ [@stdlib/utils/async/any-by-right]: https://www.npmjs.com/package/@stdlib/utils-async-any-by-right
169
197
 
170
- [@stdlib/utils/async/if-then]: https://github.com/stdlib-js/utils-async-if-then
198
+ [@stdlib/utils/async/any-by]: https://www.npmjs.com/package/@stdlib/utils-async-any-by
171
199
 
172
- [@stdlib/utils/async/while]: https://github.com/stdlib-js/utils-async-while
200
+ [@stdlib/utils/async/bifurcate-by]: https://www.npmjs.com/package/@stdlib/utils-async-bifurcate-by
173
201
 
174
- [@stdlib/utils/async/try-catch]: https://github.com/stdlib-js/utils-async-try-catch
202
+ [@stdlib/utils/async/compose]: https://www.npmjs.com/package/@stdlib/utils-async-compose
175
203
 
176
- [@stdlib/utils/async/try-then]: https://github.com/stdlib-js/utils-async-try-then
204
+ [@stdlib/utils/async/count-by]: https://www.npmjs.com/package/@stdlib/utils-async-count-by
177
205
 
178
- [@stdlib/utils/async/compose]: https://github.com/stdlib-js/utils-async-compose
206
+ [@stdlib/utils/async/do-until]: https://www.npmjs.com/package/@stdlib/utils-async-do-until
179
207
 
180
- [@stdlib/utils/async/do-until]: https://github.com/stdlib-js/utils-async-do-until
208
+ [@stdlib/utils/async/do-while]: https://www.npmjs.com/package/@stdlib/utils-async-do-while
181
209
 
182
- [@stdlib/utils/async/do-while]: https://github.com/stdlib-js/utils-async-do-while
210
+ [@stdlib/utils/async/every-by-right]: https://www.npmjs.com/package/@stdlib/utils-async-every-by-right
183
211
 
184
- [@stdlib/utils/async/function-sequence]: https://github.com/stdlib-js/utils-async-function-sequence
212
+ [@stdlib/utils/async/every-by]: https://www.npmjs.com/package/@stdlib/utils-async-every-by
185
213
 
186
- [@stdlib/utils/async/map-function]: https://github.com/stdlib-js/utils-async-map-function
214
+ [@stdlib/utils/async/for-each-right]: https://www.npmjs.com/package/@stdlib/utils-async-for-each-right
187
215
 
188
- [@stdlib/utils/async/until]: https://github.com/stdlib-js/utils-async-until
216
+ [@stdlib/utils/async/for-each]: https://www.npmjs.com/package/@stdlib/utils-async-for-each
189
217
 
190
- [@stdlib/utils/async/map-keys]: https://github.com/stdlib-js/utils-async-map-keys
218
+ [@stdlib/utils/async/function-sequence]: https://www.npmjs.com/package/@stdlib/utils-async-function-sequence
191
219
 
192
- [@stdlib/utils/async/map-values]: https://github.com/stdlib-js/utils-async-map-values
220
+ [@stdlib/utils/async/group-by]: https://www.npmjs.com/package/@stdlib/utils-async-group-by
193
221
 
194
- [@stdlib/utils/async/any-by]: https://github.com/stdlib-js/utils-async-any-by
222
+ [@stdlib/utils/async/if-else]: https://www.npmjs.com/package/@stdlib/utils-async-if-else
195
223
 
196
- [@stdlib/utils/async/any-by-right]: https://github.com/stdlib-js/utils-async-any-by-right
224
+ [@stdlib/utils/async/if-then]: https://www.npmjs.com/package/@stdlib/utils-async-if-then
197
225
 
198
- [@stdlib/utils/async/bifurcate-by]: https://github.com/stdlib-js/utils-async-bifurcate-by
226
+ [@stdlib/utils/async/inmap-right]: https://www.npmjs.com/package/@stdlib/utils-async-inmap-right
199
227
 
200
- [@stdlib/utils/async/count-by]: https://github.com/stdlib-js/utils-async-count-by
228
+ [@stdlib/utils/async/inmap]: https://www.npmjs.com/package/@stdlib/utils-async-inmap
201
229
 
202
- [@stdlib/utils/async/every-by]: https://github.com/stdlib-js/utils-async-every-by
230
+ [@stdlib/utils/async/map-function]: https://www.npmjs.com/package/@stdlib/utils-async-map-function
203
231
 
204
- [@stdlib/utils/async/every-by-right]: https://github.com/stdlib-js/utils-async-every-by-right
232
+ [@stdlib/utils/async/map-keys]: https://www.npmjs.com/package/@stdlib/utils-async-map-keys
205
233
 
206
- [@stdlib/utils/async/for-each]: https://github.com/stdlib-js/utils-async-for-each
234
+ [@stdlib/utils/async/map-values]: https://www.npmjs.com/package/@stdlib/utils-async-map-values
207
235
 
208
- [@stdlib/utils/async/for-each-right]: https://github.com/stdlib-js/utils-async-for-each-right
236
+ [@stdlib/utils/async/none-by-right]: https://www.npmjs.com/package/@stdlib/utils-async-none-by-right
209
237
 
210
- [@stdlib/utils/async/group-by]: https://github.com/stdlib-js/utils-async-group-by
238
+ [@stdlib/utils/async/none-by]: https://www.npmjs.com/package/@stdlib/utils-async-none-by
211
239
 
212
- [@stdlib/utils/async/inmap]: https://github.com/stdlib-js/utils-async-inmap
240
+ [@stdlib/utils/async/reduce-right]: https://www.npmjs.com/package/@stdlib/utils-async-reduce-right
213
241
 
214
- [@stdlib/utils/async/inmap-right]: https://github.com/stdlib-js/utils-async-inmap-right
242
+ [@stdlib/utils/async/reduce]: https://www.npmjs.com/package/@stdlib/utils-async-reduce
215
243
 
216
- [@stdlib/utils/async/none-by]: https://github.com/stdlib-js/utils-async-none-by
244
+ [@stdlib/utils/async/series-waterfall]: https://www.npmjs.com/package/@stdlib/utils-async-series-waterfall
217
245
 
218
- [@stdlib/utils/async/none-by-right]: https://github.com/stdlib-js/utils-async-none-by-right
246
+ [@stdlib/utils/async/some-by-right]: https://www.npmjs.com/package/@stdlib/utils-async-some-by-right
219
247
 
220
- [@stdlib/utils/async/reduce]: https://github.com/stdlib-js/utils-async-reduce
248
+ [@stdlib/utils/async/some-by]: https://www.npmjs.com/package/@stdlib/utils-async-some-by
221
249
 
222
- [@stdlib/utils/async/reduce-right]: https://github.com/stdlib-js/utils-async-reduce-right
250
+ [@stdlib/utils/async/tabulate-by]: https://www.npmjs.com/package/@stdlib/utils-async-tabulate-by
223
251
 
224
- [@stdlib/utils/async/some-by]: https://github.com/stdlib-js/utils-async-some-by
252
+ [@stdlib/utils/async/try-catch]: https://www.npmjs.com/package/@stdlib/utils-async-try-catch
225
253
 
226
- [@stdlib/utils/async/some-by-right]: https://github.com/stdlib-js/utils-async-some-by-right
254
+ [@stdlib/utils/async/try-then]: https://www.npmjs.com/package/@stdlib/utils-async-try-then
227
255
 
228
- [@stdlib/utils/async/tabulate-by]: https://github.com/stdlib-js/utils-async-tabulate-by
256
+ [@stdlib/utils/async/until]: https://www.npmjs.com/package/@stdlib/utils-async-until
229
257
 
230
- [@stdlib/utils/async/series-waterfall]: https://github.com/stdlib-js/utils-async-series-waterfall
258
+ [@stdlib/utils/async/while]: https://www.npmjs.com/package/@stdlib/utils-async-while
231
259
 
232
260
  <!-- </toc-links> -->
233
261
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/utils-async",
3
- "version": "0.0.3",
3
+ "version": "0.0.7",
4
4
  "description": "Standard async utilities.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -15,6 +15,7 @@
15
15
  ],
16
16
  "main": "lib/index.js",
17
17
  "directories": {
18
+ "doc": "./docs",
18
19
  "example": "./examples",
19
20
  "lib": "./lib",
20
21
  "test": "./test"
@@ -26,7 +27,7 @@
26
27
  "examples": "make examples",
27
28
  "benchmark": "make benchmark"
28
29
  },
29
- "homepage": "https://github.com/stdlib-js/stdlib",
30
+ "homepage": "https://stdlib.io",
30
31
  "repository": {
31
32
  "type": "git",
32
33
  "url": "git://github.com/stdlib-js/utils-async.git"
package/CHANGELOG.md DELETED
@@ -1,5 +0,0 @@
1
- # CHANGELOG
2
-
3
- > Package changelog.
4
-
5
- See [GitHub Releases](https://github.com/stdlib-js/utils-async/releases) for the changelog.