8000 Auto-generated commit · stdlib-js/utils-async-reduce@cf2da7a · GitHub
[go: up one dir, main page]

Skip to content
8000

Commit cf2da7a

committed
Auto-generated commit
1 parent f215449 commit cf2da7a

File tree

5 files changed

+22
-14
lines changed

5 files changed

+22
-14
lines changed

.github/.keepalive

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2024-01-01T02:40:49.822Z
1+
2024-02-01T03:13:08.822Z

NOTICE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Copyright (c) 2016-2023 The Stdlib Authors.
1+
Copyright (c) 2016-2024 The Stdlib Authors.

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,14 @@ npm install @stdlib/utils-async-reduce
5555

5656
Alternatively,
5757

58-
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm` branch][esm-url].
59-
- If you are using Deno, visit the [`deno` branch][deno-url].
60-
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd` branch][umd-url].
58+
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
59+
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
60+
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
6161

6262
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
6363

64+
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
65+
6466
</section>
6567

6668
<section class="usage">
@@ -512,8 +514,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
512514
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
513515

514516
[deno-url]: https://github.com/stdlib-js/utils-async-reduce/tree/deno
517+
[deno-readme]: https://github.com/stdlib-js/utils-async-reduce/blob/deno/README.md
515518
[umd-url]: https://github.com/stdlib-js/utils-async-reduce/tree/umd
519+
[umd-readme]: https://github.com/stdlib-js/utils-async-reduce/blob/umd/README.md
516520
[esm-url]: https://github.com/stdlib-js/utils-async-reduce/tree/esm
521+
[esm-readme]: https://github.com/stdlib-js/utils-async-reduce/blob/esm/README.md
517522
[branches-url]: https://github.com/stdlib-js/utils-async-reduce/blob/main/branches.md
518523

519524
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-async-reduce/main/LICENSE

branches.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ This repository has the following branches:
2424

2525
- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place.
2626
- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network).
27-
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers.
28-
- **deno**: [Deno][deno-url] branch for use in Deno.
29-
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments.
27+
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]).
28+
- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]).
29+
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]).
3030

3131
The following diagram illustrates the relationships among the above branches:
3232

@@ -49,5 +49,8 @@ C -->|bundle| F[umd];
4949
[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/async/reduce
5050
[production-url]: https://github.com/stdlib-js/utils-async-reduce/tree/production
5151
[deno-url]: https://github.com/stdlib-js/utils-async-reduce/tree/deno
52+
[deno-readme]: https://github.com/stdlib-js/utils-async-reduce/blob/deno/README.md
5253
[umd-url]: https://github.com/stdlib-js/utils-async-reduce/tree/umd
53-
[esm-url]: https://github.com/stdlib-js/utils-async-reduce/tree/esm
54+
[umd-readme]: https://github.com/stdlib-js/utils-async-reduce/blob/umd/README.md
55+
[esm-url]: https://github.com/stdlib-js/utils-async-reduce/tree/esm
56+
[esm-readme]: https://github.com/stdlib-js/utils-async-reduce/blob/esm/README.md

docs/types/index.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ interface ReduceAsync {
143143
* @throws must provide valid options
144144
*
145145
* @example
146-
* var readFile = require( `@stdlib/fs/read-file` );
146+
* var readFile = require( '@stdlib/fs-read-file' );
147147
*
148148
* function done( error, acc ) {
149149
* if ( error ) {
@@ -192,7 +192,7 @@ interface ReduceAsync {
192192
* @param done - function to invoke upon completion
193193
*
194194
* @example
195-
* var readFile = require( `@stdlib/fs/read-file` );
195+
* var readFile = require( '@stdlib/fs-read-file' );
196196
*
197197
* function done( error, acc ) {
198198
* if ( error ) {
@@ -244,7 +244,7 @@ interface ReduceAsync {
244244
* @returns function which invokes the provided function once for each element in a collection
245245
*
246246
* @example
247-
* var readFile = require( `@stdlib/fs/read-file` );
247+
* var readFile = require( '@stdlib/fs-read-file' );
248248
*
249249
* function read( acc, file, next ) {
250250
* var opts = {
@@ -303,7 +303,7 @@ interface ReduceAsync {
303303
* @returns function which invokes the provided function once for each element in a collection
304304
*
305305
* @example
306-
* var readFile = require( `@stdlib/fs/read-file` );
306+
* var readFile = require( '@stdlib/fs-read-file' );
307307
*
308308
* function read( acc, file, next ) {
309309
* var opts = {
@@ -365,7 +365,7 @@ interface ReduceAsync {
365365
* @throws must provide valid options
366366
*
367367
* @example
368-
* var readFile = require( `@stdlib/fs/read-file` );
368+
* var readFile = require( '@stdlib/fs-read-file' );
369369
*
370370
* function done( error, acc ) {
371371
* if ( error ) {

0 commit comments

Comments
 (0)
0