Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Feb 1, 2024
1 parent eb781e1 commit 1916de8
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/.keepalive
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2024-01-01T02:41:56.680Z
2024-02-01T03:14:35.175Z
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Copyright (c) 2016-2023 The Stdlib Authors.
Copyright (c) 2016-2024 The Stdlib Authors.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,14 @@ npm install @stdlib/utils-async-any-by-right

Alternatively,

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

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

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.

</section>

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

[deno-url]: https://github.com/stdlib-js/utils-async-any-by-right/tree/deno
[deno-readme]: https://github.com/stdlib-js/utils-async-any-by-right/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/utils-async-any-by-right/tree/umd
[umd-readme]: https://github.com/stdlib-js/utils-async-any-by-right/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/utils-async-any-by-right/tree/esm
[esm-readme]: https://github.com/stdlib-js/utils-async-any-by-right/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/utils-async-any-by-right/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-async-any-by-right/main/LICENSE
Expand Down
11 changes: 7 additions & 4 deletions branches.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ This repository has the following branches:

- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place.
- **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).
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers.
- **deno**: [Deno][deno-url] branch for use in Deno.
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments.
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]).
- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]).
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]).

The following diagram illustrates the relationships among the above branches:

Expand All @@ -49,5 +49,8 @@ C -->|bundle| F[umd];
[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/async/any-by-right
[production-url]: https://github.com/stdlib-js/utils-async-any-by-right/tree/production
[deno-url]: https://github.com/stdlib-js/utils-async-any-by-right/tree/deno
[deno-readme]: https://github.com/stdlib-js/utils-async-any-by-right/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/utils-async-any-by-right/tree/umd
[esm-url]: https://github.com/stdlib-js/utils-async-any-by-right/tree/esm
[umd-readme]: https://github.com/stdlib-js/utils-async-any-by-right/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/utils-async-any-by-right/tree/esm
[esm-readme]: https://github.com/stdlib-js/utils-async-any-by-right/blob/esm/README.md
10 changes: 5 additions & 5 deletions docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ interface AnyByRightAsync {
* @throws must provide valid options
*
* @example
* var readFile = require( `@stdlib/fs/read-file` );
* var readFile = require( '@stdlib/fs-read-file' );
*
* function done( error, bool ) {
* if ( error ) {
Expand Down Expand Up @@ -186,7 +186,7 @@ interface AnyByRightAsync {
* @param done - function to invoke upon completion
*
* @example
* var readFile = require( `@stdlib/fs/read-file` );
* var readFile = require( '@stdlib/fs-read-file' );
*
* function done( error, bool ) {
* if ( error ) {
Expand Down Expand Up @@ -239,7 +239,7 @@ interface AnyByRightAsync {
* @returns function which invokes the predicate function once for each element in a collection
*
* @example
* var readFile = require( `@stdlib/fs/read-file` );
* var readFile = require( '@stdlib/fs-read-file' );
*
* function predicate( file, next ) {
* var opts = {
Expand Down Expand Up @@ -297,7 +297,7 @@ interface AnyByRightAsync {
* @returns function which invokes the predicate function once for each element in a collection
*
* @example
* var readFile = require( `@stdlib/fs/read-file` );
* var readFile = require( '@stdlib/fs-read-file' );
*
* function predicate( file, next ) {
* var opts = {
Expand Down Expand Up @@ -357,7 +357,7 @@ interface AnyByRightAsync {
* @throws must provide valid options
*
* @example
* var readFile = require( `@stdlib/fs/read-file` );
* var readFile = require( '@stdlib/fs-read-file' );
*
* function done( error, bool ) {
* if ( error ) {
Expand Down

0 comments on commit 1916de8

Please sign in to comment.