Skip to content

Commit 859c7d3

Browse files
committed
Auto-generated commit
1 parent 0b6f460 commit 859c7d3

File tree

5 files changed

+22
-14
lines changed

5 files changed

+22
-14
lines changed

.github/.keepalive

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2024-01-01T02:41:03.944Z
1+
2024-02-01T03:13:27.408Z

NOTICE

+1-1
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

+8-3
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,14 @@ npm install @stdlib/utils-async-none-by-right
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">
@@ -488,8 +490,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
488490
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
489491

490492
[deno-url]: https://github.com/stdlib-js/utils-async-none-by-right/tree/deno
493+
[deno-readme]: https://github.com/stdlib-js/utils-async-none-by-right/blob/deno/README.md
491494
[umd-url]: https://github.com/stdlib-js/utils-async-none-by-right/tree/umd
495+
[umd-readme]: https://github.com/stdlib-js/utils-async-none-by-right/blob/umd/README.md
492496
[esm-url]: https://github.com/stdlib-js/utils-async-none-by-right/tree/esm
497+
[esm-readme]: https://github.com/stdlib-js/utils-async-none-by-right/blob/esm/README.md
493498
[branches-url]: https://github.com/stdlib-js/utils-async-none-by-right/blob/main/branches.md
494499

495500
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-async-none-by-right/main/LICENSE

branches.md

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

docs/types/index.d.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ interface NoneByRightAsync {
137137
* @throws must provide valid options
138138
*
139139
* @example
140-
* var readFile = require( `@stdlib/fs/read-file` );
140+
* var readFile = require( '@stdlib/fs-read-file' );
141141
*
142142
* function done( error, bool ) {
143143
* if ( error ) {
@@ -186,7 +186,7 @@ interface NoneByRightAsync {
186186
* @param done - function to invoke upon completion
187187
*
188188
* @example
189-
* var readFile = require( `@stdlib/fs/read-file` );
189+
* var readFile = require( '@stdlib/fs-read-file' );
190190
*
191191
* function done( error, bool ) {
192192
* if ( error ) {
@@ -240,7 +240,7 @@ interface NoneByRightAsync {
240240
* @returns function which invokes the predicate function once for each element in a collection
241241
*
242242
* @example
243-
* var readFile = require( `@stdlib/fs/read-file` );
243+
* var readFile = require( '@stdlib/fs-read-file' );
244244
*
245245
* function predicate( file, next ) {
246246
* var opts = {
@@ -300,7 +300,7 @@ interface NoneByRightAsync {
300300
* @returns function which invokes the predicate function once for each element in a collection
301301
*
302302
* @example
303-
* var readFile = require( `@stdlib/fs/read-file` );
303+
* var readFile = require( '@stdlib/fs-read-file' );
304304
*
305305
* function predicate( file, next ) {
306306
* var opts = {
@@ -360,7 +360,7 @@ interface NoneByRightAsync {
360360
* @throws must provide valid options
361361
*
362362
* @example
363-
* var readFile = require( `@stdlib/fs/read-file` );
363+
* var readFile = require( '@stdlib/fs-read-file' );
364364
*
365365
* function done( error, bool ) {
366366
* if ( error ) {

0 commit comments

Comments
 (0)