From 8eea6df188b2481bbd0bbf68e1ae6315da746e7c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 03:13:00 +0000 Subject: [PATCH] Auto-generated commit --- .github/.keepalive | 2 +- NOTICE | 2 +- README.md | 11 ++++++++--- branches.md | 11 +++++++---- docs/types/index.d.ts | 10 +++++----- 5 files changed, 22 insertions(+), 14 deletions(-) diff --git a/.github/.keepalive b/.github/.keepalive index 8ed6504..f3eb2e7 100644 --- a/.github/.keepalive +++ b/.github/.keepalive @@ -1 +1 @@ -2024-01-01T02:40:40.128Z +2024-02-01T03:12:56.323Z diff --git a/NOTICE b/NOTICE index f7aca1b..e6e7482 100644 --- a/NOTICE +++ b/NOTICE @@ -1 +1 @@ -Copyright (c) 2016-2023 The Stdlib Authors. +Copyright (c) 2016-2024 The Stdlib Authors. diff --git a/README.md b/README.md index 8802745..0e7460c 100644 --- a/README.md +++ b/README.md @@ -55,12 +55,14 @@ npm install @stdlib/utils-async-some-by 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. +
@@ -488,8 +490,11 @@ Copyright © 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-some-by/tree/deno +[deno-readme]: https://github.com/stdlib-js/utils-async-some-by/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/utils-async-some-by/tree/umd +[umd-readme]: https://github.com/stdlib-js/utils-async-some-by/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/utils-async-some-by/tree/esm +[esm-readme]: https://github.com/stdlib-js/utils-async-some-by/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/utils-async-some-by/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-async-some-by/main/LICENSE diff --git a/branches.md b/branches.md index e0c47bb..5c05f25 100644 --- a/branches.md +++ b/branches.md @@ -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: @@ -49,5 +49,8 @@ C -->|bundle| F[umd]; [stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/async/some-by [production-url]: https://github.com/stdlib-js/utils-async-some-by/tree/production [deno-url]: https://github.com/stdlib-js/utils-async-some-by/tree/deno +[deno-readme]: https://github.com/stdlib-js/utils-async-some-by/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/utils-async-some-by/tree/umd -[esm-url]: https://github.com/stdlib-js/utils-async-some-by/tree/esm \ No newline at end of file +[umd-readme]: https://github.com/stdlib-js/utils-async-some-by/blob/umd/README.md +[esm-url]: https://github.com/stdlib-js/utils-async-some-by/tree/esm +[esm-readme]: https://github.com/stdlib-js/utils-async-some-by/blob/esm/README.md \ No newline at end of file diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index 59474bf..b53102b 100644 --- a/docs/types/index.d.ts +++ b/docs/types/index.d.ts @@ -140,7 +140,7 @@ interface SomeByAsync { * @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 ) { @@ -192,7 +192,7 @@ interface SomeByAsync { * @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 ) { @@ -245,7 +245,7 @@ interface SomeByAsync { * @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 = { @@ -303,7 +303,7 @@ interface SomeByAsync { * @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 = { @@ -366,7 +366,7 @@ interface SomeByAsync { * @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 ) {