8000 Auto-generated commit · stdlib-js/utils-async-group-by@c6b8411 · GitHub
[go: up one dir, main page]
Skip to content

Commit c6b8411

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 35c2cb2 commit c6b8411

File tree

5 files changed

+26
-18
lines changed

5 files changed

+26
-18
lines changed

‎.github/.keepalive

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2024-01-01T02:41:18.147Z
1+
2024-02-01T03:13:45.950Z

‎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-group-by
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">
@@ -550,8 +552,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
550552
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
551553

552554
[deno-url]: https://github.com/stdlib-js/utils-async-group-by/tree/deno
555+
[deno-readme]: https://github.com/stdlib-js/utils-async-group-by/blob/deno/README.md
553556
[umd-url]: https://github.com/stdlib-js/utils-async-group-by/tree/umd
557+
[umd-readme]: https://github.com/stdlib-js/utils-async-group-by/blob/umd/README.md
554558
[esm-url]: https://github.com/stdlib-js/utils-async-group-by/tree/esm
559+
[esm-readme]: https://github.com/stdlib-js/utils-async-group-by/blob/esm/README.md
555560
[branches-url]: https://github.com/stdlib-js/utils-async-group-by/blob/main/branches.md
556561

557562
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-async-group-by/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/group-by
5050
[production-url]: https://github.com/stdlib-js/utils-async-group-by/tree/production
5151
[deno-url]: https://github.com/stdlib-js/utils-async-group-by/tree/deno
52+
[deno-readme]: https://github.com/stdlib-js/utils-async-group-by/blob/deno/README.md
5253
[umd-url]: https://github.com/stdlib-js/utils-async-group-by/tree/umd
53-
[esm-url]: https://github.com/stdlib-js/utils-async-group-by/tree/esm
54+
[umd-readme]: https://github.com/stdlib-js/utils-async-group-by/blob/umd/README.md
55+
[esm-url]: https://github.com/stdlib-js/utils-async-group-by/tree/esm
56+
[esm-readme]: https://github.com/stdlib-js/utils-async-group-by/blob/esm/README.md

‎docs/types/index.d.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ interface GroupByAsync {
273273
* @throws must provide valid options
274274
*
275275
* @example
276-
* var readFile = require( `@stdlib/fs/read-file` );
276+
* var readFile = require( '@stdlib/fs-read-file' );
277277
*
278278
* function done( error, result ) {
279279
* if ( error ) {
@@ -323,7 +323,7 @@ interface GroupByAsync {
323323
* @throws must provide valid options
324324
*
325325
* @example
326-
* var readFile = require( `@stdlib/fs/read-file` );
326+
* var readFile = require( '@stdlib/fs-read-file' );
327327
*
328328
* function done( error, result ) {
329329
* if ( error ) {
@@ -373,7 +373,7 @@ interface GroupByAsync {
373373
* @throws must provide valid options
374374
*
375375
* @example
376-
* var readFile = require( `@stdlib/fs/read-file` );
376+
* var readFile = require( '@stdlib/fs-read-file' );
377377
*
378378
* function done( error, result ) {
379379
* if ( error ) {
@@ -417,7 +417,7 @@ interface GroupByAsync {
417417
* @param done - function to invoke upon completion
418418
*
419419
* @example
420-
* var readFile = require( `@stdlib/fs/read-file` );
420+
* var readFile = require( '@stdlib/fs-read-file' );
421421
*
422422
* function done( error, result ) {
423423
* if ( error ) {
@@ -466,7 +466,7 @@ interface GroupByAsync {
466466
* @returns function which invokes the indicator function once for each element in a collection
467467
*
468468
* @example
469-
* var readFile = require( `@stdlib/fs/read-file` );
469+
* var readFile = require( '@stdlib/fs-read-file' );
470470
*
471471
* function indicator( file, next ) {
472472
* var opts = {
@@ -525,7 +525,7 @@ interface GroupByAsync {
525525
* @returns function which invokes the indicator function once for each element in a collection
526526
*
527527
* @example
528-
* var readFile = require( `@stdlib/fs/read-file` );
528+
* var readFile = require( '@stdlib/fs-read-file' );
529529
*
530530
* function indicator( file, next ) {
531531
* var opts = {
@@ -584,7 +584,7 @@ interface GroupByAsync {
584584
* @returns function which invokes the indicator function once for each element in a collection
585585
*
586586
* @example
587-
* var readFile = require( `@stdlib/fs/read-file` );
587+
* var readFile = require( '@stdlib/fs-read-file' );
588588
*
589589
* function indicator( file, next ) {
590590
* var opts = {
637637
* @returns function which invokes the indicator function once for each element in a collection
638638
*
639639
* @example
640-
* var readFile = require( `@stdlib/fs/read-file` );
640+
* var readFile = require( '@stdlib/fs-read-file' );
641641
*
642642
* function indicator( file, next ) {
643643
* var opts = {
@@ -694,7 +694,7 @@ interface GroupByAsync {
694694
* @throws must provide valid options
695695
*
696696
* @example
697-
* var readFile = require( `@stdlib/fs/read-file` );
697+
* var readFile = require( '@stdlib/fs-read-file' );
698698
*
699699
* function done( error, result ) {
700700
* if ( error ) {

0 commit comments

Comments
 (0)
0