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

Commit a46ce04

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent f53265b commit a46ce04

File tree

5 files changed

+41
-33
lines changed

5 files changed

+41
-33
lines changed

‎.github/.keepalive

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2024-01-01T02:56:48.926Z
1+
2024-02-01T03:32:58.217Z

‎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
@@ -45,12 +45,14 @@ npm install @stdlib/utils-async
4545

4646
Alternatively,
4747

48-
- 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].
49-
- If you are using Deno, visit the [`deno` branch][deno-url].
50-
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd` branch][umd-url].
48+
- 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]).
49+
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
50+
- 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]).
5151

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

54+
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.
55+
5456
</section>
5557

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

207209
[deno-url]: https://github.com/stdlib-js/utils-async/tree/deno
210+
[deno-readme]: https://github.com/stdlib-js/utils-async/blob/deno/README.md
208211
[umd-url]: https://github.com/stdlib-js/utils-async/tree/umd
212+
[umd-readme]: https://github.com/stdlib-js/utils-async/blob/umd/README.md
209213
[esm-url]: https://github.com/stdlib-js/utils-async/tree/esm
214+
[esm-readme]: https://github.com/stdlib-js/utils-async/blob/esm/README.md
210215
[branches-url]: https://github.com/stdlib-js/utils-async/blob/main/branches.md
211216

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

‎docs/types/index.d.ts

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ interface Namespace {
7575
* @throws must provide valid options
7676
*
7777
* @example
78-
* var readFile = require( `@stdlib/fs/read-file` );
78+
* var readFile = require( '@stdlib/fs-read-file' );
7979
*
8080
* function done( error, bool ) {
81< A3E2 /td>81
* if ( error ) {
@@ -129,7 +129,7 @@ interface Namespace {
129129
* @throws must provide valid options
130130
*
131131
* @example
132-
* var readFile = require( `@stdlib/fs/read-file` );
132+
* var readFile = require( '@stdlib/fs-read-file' );
133133
*
134134
* function done( error, bool ) {
135135
* if ( error ) {
@@ -183,7 +183,7 @@ interface Namespace {
183183
* @throws must provide valid options
184184
*
185185
* @example
186-
* var readFile = require( `@stdlib/fs/read-file` );
186+
* var readFile = require( '@stdlib/fs-read-file' );
187187
*
188188
* function done( error, result ) {
189189
* if ( error ) {
@@ -280,7 +280,7 @@ interface Namespace {
280280
* @throws must provide valid options
281281
*
282282
* @example
283-
* var readFile = require( `@stdlib/fs/read-file` );
283+
* var readFile = require( '@stdlib/fs-read-file' );
284284
*
285285
* function done( error, result ) {
286286
* if ( error ) {
@@ -392,7 +392,7 @@ interface Namespace {
392392
* @throws must provide valid options
393393
*
394394
* @example
395-
* var readFile = require( `@stdlib/fs/read-file` );
395+
* var readFile = require( '@stdlib/fs-read-file' );
396396
*
397397
* function done( error, bool ) {
398398
* if ( error ) {
@@ -446,7 +446,7 @@ interface Namespace {
446446
* @throws must provide valid options
447447
*
448448
* @example
449-
* var readFile = require( `@stdlib/fs/read-file` );
449+
* var readFile = require( '@stdlib/fs-read-file' );
450450
*
451451
* function done( error, bool ) {
452452
* if ( error ) {
@@ -500,7 +500,7 @@ interface Namespace {
500500
* @throws must provide valid options
501501
*
502502
* @example
503-
* var readFile = require( `@stdlib/fs/read-file` );
503+
* var readFile = require( '@stdlib/fs-read-file' );
504504
*
505505
* function done( error ) {
506506
* if ( error ) {
@@ -551,7 +551,7 @@ interface Namespace {
551551
* @throws must provide valid options
552552
*
553553
* @example
554-
* var readFile = require( `@stdlib/fs/read-file` );
554+
* var readFile = require( '@stdlib/fs-read-file' );
555555
*
556556
* function done( error ) {
557557
* if ( error ) {
@@ -646,7 +646,7 @@ interface Namespace {
646646
* @throws must provide valid options
647647
*
648648
* @example
649-
* var readFile = require( `@stdlib/fs/read-file` );
649+
* var readFile = require( '@stdlib/fs-read-file' );
650650
*
651651
* function done( error, result ) {
652652
* if ( error ) {
@@ -687,7 +687,7 @@ interface Namespace {
687687
* @param done - callback to invoke upon completion
688688
*
689689
* @example
690-
* var randu = require( `@stdlib/random/base/randu` );
690+
* var randu = require( '@stdlib/random-base-randu' );
691691
*
692692
* function predicate( clbk ) {
693693
* setTimeout( onTimeout, 0 );
@@ -715,7 +715,7 @@ interface Namespace {
715715
* @param done - callback to invoke upon completion
716716
*
717717
* @example
718-
* var randu = require( `@stdlib/random/base/randu` );
718+
* var randu = require( '@stdlib/random-base-randu' );
719719
*
720720
* function predicate( clbk ) {
721721
* setTimeout( onTimeout, 0 );
@@ -766,7 +766,7 @@ interface Namespace {
766766
* @throws must provide valid options
767767
*
768768
* @example
769-
* var readFile = require( `@stdlib/fs/read-file` );
769+
* var readFile = require( '@stdlib/fs-read-file' );
770770
*
771771
* function done( error, results ) {
772772
* if ( error ) {
@@ -816,7 +816,7 @@ interface Namespace {
816816
* @throws must provide valid options
817817
*
818818
* @example
819-
* var readFile = require( `@stdlib/fs/read-file` );
819+
* var readFile = require( '@stdlib/fs-read-file' );
820820
*
821821
* function done( error, results ) {
822822
* if ( error ) {
@@ -908,7 +908,7 @@ interface Namespace {
908908
* @throws must provide valid options
909909
*
910910
* @example
911-
* var readFile = require( `@stdlib/fs/read-file` );
911+
* var readFile = require( '@stdlib/fs-read-file' );
912912
*
913913
* function read( key, value, next ) {
914914
* var opts = {
@@ -968,7 +968,7 @@ interface Namespace {
968968
* @throws must provide valid options
969969
*
970970
* @example
971-
* var stat = require( `fs` ).stat;
971+
* var stat = require( 'fs' ).stat;
972972
*
973973
* function getStats( file, next ) {
974974
* stat( file, onStats );
@@ -1022,7 +1022,7 @@ interface Namespace {
10221022
* @throws must provide valid options
10231023
*
10241024
* @example
1025-
* var readFile = require( `@stdlib/fs/read-file` );
1025+
* var readFile = require( '@stdlib/fs-read-file' );
10261026
*
10271027
* function done( error, bool ) {
10281028
* if ( error ) {
@@ -1076,7 +1076,7 @@ interface Namespace {
10761076
* @throws must provide valid options
10771077
*
10781078
* @example
1079-
* var readFile = require( `@stdlib/fs/read-file` );
1079+
* var readFile = require( '@stdlib/fs-read-file' );
10801080
*
10811081
* function done( error, bool ) {
10821082
* if ( error ) {
@@ -1131,7 +1131,7 @@ interface Namespace {
11311131
* @throws must provide valid options
11321132
*
11331133
* @example
1134-
* var readFile = require( `@stdlib/fs/read-file` );
1134+
* var readFile = require( '@stdlib/fs-read-file' );
11351135
*
11361136
* function done( error, acc ) {
11371137
* if ( error ) {
@@ -1185,7 +1185,7 @@ interface Namespace {
11851185
* @throws must provide valid options
11861186
*
11871187
* @example
1188-
* var readFile = require( `@stdlib/fs/read-file` );
1188+
* var readFile = require( '@stdlib/fs-read-file' );
11891189
*
11901190
* function done( error, acc ) {
11911191
* if ( error ) {
@@ -1271,7 +1271,7 @@ interface Namespace {
12711271
* @throws must provide valid options
12721272
*
12731273
* @example
1274-
* var readFile = require( `@stdlib/fs/read-file` );
1274+
* var readFile = require( '@stdlib/fs-read-file' );
12751275
*
12761276
* function done( error, bool ) {
12771277
* if ( error ) {
@@ -1327,7 +1327,7 @@ interface Namespace {
13271327
* @throws must provide valid options
13281328
*
13291329
* @example
1330-
* var readFile = require( `@stdlib/fs/read-file` );
1330+
* var readFile = require( '@stdlib/fs-read-file' );
13311331
*
13321332
* function done( error, bool ) {
13331333
* if ( error ) {
@@ -1386,7 +1386,7 @@ interface Namespace {
13861386
* @throws must provide valid options
13871387
*
13881388
* @example
1389-
* var readFile = require( `@stdlib/fs/read-file` );
1389+
* var readFile = require( '@stdlib/fs-read-file' );
13901390
*
13911391
* function done( error, result ) {
13921392
* if ( error ) {
@@ -1426,7 +1426,7 @@ interface Namespace {
14261426
* @param done - callback to invoke upon completion
14271427
*
14281428
* @example
1429-
* var randu = require( `@stdlib/random/base/randu` );
1429+
* var randu = require( '@stdlib/random-base-randu' );
14301430
*
14311431
* function x( clbk ) {
14321432
* setTimeout( onTimeout, 0 );
@@ -1457,7 +1457,7 @@ interface Namespace {
14571457
* @param done - callback to invoke upon completion
14581458
*
14591459
* @example
1460-
* var randu = require( `@stdlib/random/base/randu` );
1460+
* var randu = require( '@stdlib/random-base-randu' );
14611461
*
14621462
* function x( clbk ) {
14631463
* setTimeout( onTimeout, 0 );

0 commit comments

Comments
 (0)
0