8000 Auto-generated commit · stdlib-js/fs-open@89a2f35 · GitHub
[go: up one dir, main page]
Skip to content

Commit 89a2f35

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent b0a827b commit 89a2f35

File tree

5 files changed

+23
-15
lines changed

5 files changed

+23
-15
lines changed

‎.github/.keepalive

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2024-01-01T00:44:48.469Z
1+
2024-02-01T00:44:43.015Z

‎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/fs-open
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">
@@ -277,8 +279,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
277279
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
278280

279281
[deno-url]: https://github.com/stdlib-js/fs-open/tree/deno
282+
[deno-readme]: https://github.com/stdlib-js/fs-open/blob/deno/README.md
280283
[umd-url]: https://github.com/stdlib-js/fs-open/tree/umd
284+
[umd-readme]: https://github.com/stdlib-js/fs-open/blob/umd/README.md
281285
[esm-url]: https://github.com/stdlib-js/fs-open/tree/esm
286+
[esm-readme]: https://github.com/stdlib-js/fs-open/blob/esm/README.md
282287
[branches-url]: https://github.com/stdlib-js/fs-open/blob/main/branches.md
283288

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

‎docs/types/index.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ interface Open {
4343
* @param clbk - callback to invoke after opening a file
4444
*
4545
* @example
46-
* var closeSync = require( `@stdlib/fs/close` ).sync;
46+
* var closeSync = require( '@stdlib/fs-close' ).sync;
4747
*
4848
* function onOpen( error, fd ) {
4949
* if ( error ) {
@@ -63,7 +63,7 @@ interface Open {
6363
* @param clbk - callback to invoke after opening a file
6464
*
6565
* @example
66-
* var closeSync = require( `@stdlib/fs/close` ).sync;
66+
* var closeSync = require( '@stdlib/fs-close' ).sync;
6767
*
6868
* function onOpen( error, fd ) {
6969
* if ( error ) {
@@ -82,7 +82,7 @@ interface Open {
8282
* @param clbk - callback to invoke after opening a file
8383
*
8484
* @example
85-
* var closeSync = require( `@stdlib/fs/close` ).sync;
85+
* var closeSync = require( '@stdlib/fs-close' ).sync;
8686
*
8787
* function onOpen( error, fd ) {
8888
* if ( error ) {
@@ -103,7 +103,7 @@ interface Open {
103103
* @returns file descriptor or an error
104104
*
105105
* @example
106-
* var closeSync = require( `@stdlib/fs/close` ).sync;
106+
* var closeSync = require( '@stdlib/fs-close' ).sync;
107107
*
108108
* var fd = open.sync( __filename, 'r+' );
109109
* if ( fd instanceof Error ) {
@@ -123,7 +123,7 @@ interface Open {
123123
* @param clbk - callback to invoke after opening a file
124124
*
125125
* @example
126-
* var closeSync = require( `@stdlib/fs/close` ).sync;
126+
* var closeSync = require( '@stdlib/fs-close' ).sync;
127127
*
128128
* function onOpen( error, fd ) {
129129
* if ( error ) {
@@ -134,7 +134,7 @@ interface Open {
134134
* open( __filename, onOpen );
135135
*
136136
* @example
137-
* var closeSync = require( `@stdlib/fs/close` ).sync;
137+
* var closeSync = require( '@stdlib/fs-close' ).sync;
138138
*
139139
* var fd = open.sync( __filename );
140140
* if ( fd instanceof Error ) {

0 commit comments

Comments
 (0)
0