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

Commit c4408bf

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 8b88bf4 commit c4408bf

File tree

5 files changed

+22
-14
lines changed

5 files changed

+22
-14
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:58.189Z
1+
2024-02-01T03:33:10.065Z

‎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-map-keys
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">
@@ -466,8 +468,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
466468
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
467469

468470
[deno-url]: https://github.com/stdlib-js/utils-async-map-keys/tree/deno
471+
[deno-readme]: https://github.com/stdlib-js/utils-async-map-keys/blob/deno/README.md
469472
[umd-url]: https://github.com/stdlib-js/utils-async-map-keys/tree/umd
473+
[umd-readme]: https://github.com/stdlib-js/utils-async-map-keys/blob/umd/README.md
470474
[esm-url]: https://github.com/stdlib-js/utils-async-map-keys/tree/esm
475+
[esm-readme]: https://github.com/stdlib-js/utils-async-map-keys/blob/esm/README.md
471476
[branches-url]: https://github.com/stdlib-js/utils-async-map-keys/blob/main/branches.md
472477

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

‎docs/types/index.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ interface MapKeysAsync {
164164
* @throws must provide valid options
165165
*
166166
* @example
167-
* var readFile = require( `@stdlib/fs/read-file` );
167+
* var readFile = require( '@stdlib/fs-read-file' );
168168
*
169169
* function read( key, value, next ) {
170170
* var opts = {
@@ -219,7 +219,7 @@ interface MapKeysAsync {
219219
* @param done - function to invoke upon completion
220220
*
221221
* @example
222-
* var readFile = require( `@stdlib/fs/read-file` );
222+
* var readFile = require( '@stdlib/fs-read-file' );
223223
*
224224
* function read( key, value, next ) {
225225
* var opts = {
@@ -274,7 +274,7 @@ interface MapKeysAsync {
274274
* @returns function which maps keys from one object to a new object having the same values
275275
*
276276
* @example
277-
* var readFile = require( `@stdlib/fs/read-file` );
277+
* var readFile = require( '@stdlib/fs-read-file' );
278278
*
279279
* function read( key, value, next ) {
280280
* var opts = {
@@ -331,7 +331,7 @@ interface MapKeysAsync {
331331
* @returns function which maps keys from one object to a new object having the same values
332332
*
333333
* @example
334-
* var readFile = require( `@stdlib/fs/read-file` );
334+
* var readFile = require( '@stdlib/fs-read-file' );
335335
*
336336
* function read( key, value, next ) {
337337
* var opts = {
@@ -391,7 +391,7 @@ interface MapKeysAsync {
391391
* @throws must provide valid options
392392
*
393393
* @example
394-
* var readFile = require( `@stdlib/fs/read-file` );
394+
* var readFile = require( '@stdlib/fs-read-file' );
395395
*
396396
* function read( key, value, next ) {
397397
* var opts = {

0 commit comments

Comments
 (0)
0