Skip to content

Commit b6d5f87

Browse files
PlaneshifterPlaneshifter
committed
Consolidate sections
1 parent 5060e5e commit b6d5f87

1 file changed

Lines changed: 11 additions & 35 deletions

File tree

‎lib/node_modules/@stdlib/fs/README.md‎

Lines changed: 11 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -39,44 +39,20 @@ var f = fs;
3939
// returns {...}
4040
```
4141

42-
The namespace contains functions to read files from disk.
43-
44-
<!-- <toc keywords="+read"> -->
42+
<!-- <toc pattern="*"> -->
4543

4644
<div class="namespace-toc">
4745

46+
- <span class="signature">[`exists( path, clbk )`][@stdlib/fs/exists]</span><span class="delimiter">: </span><span class="description">test whether a path exists on the filesystem.</span>
4847
- <span class="signature">[`readDir( path, clbk )`][@stdlib/fs/read-dir]</span><span class="delimiter">: </span><span class="description">read the contents of a directory.</span>
4948
- <span class="signature">[`readFile( file, [options,] clbk )`][@stdlib/fs/read-file]</span><span class="delimiter">: </span><span class="description">read the entire contents of a file.</span>
5049
- <span class="signature">[`readFileList( filepaths, [options,] clbk )`][@stdlib/fs/read-file-list]</span><span class="delimiter">: </span><span class="description">read the entire contents of each file in a file list.</span>
5150
- <span class="signature">[`readJSON( file, [options,] clbk )`][@stdlib/fs/read-json]</span><span class="delimiter">: </span><span class="description">read a file as JSON.</span>
5251
- <span class="signature">[`readWASM( file, [options,] clbk )`][@stdlib/fs/read-wasm]</span><span class="delimiter">: </span><span class="description">read a file as WebAssembly.</span>
53-
54-
</div>
55-
56-
<!-- </toc> -->
57-
58-
Furthermore, it contains functions to write `data` to a `file`.
59-
60-
<!-- <toc keywords="+write"> -->
61-
62-
<div class="namespace-toc">
63-
64-
- <span class="signature">[`writeFile( file, data, [options,] clbk )`][@stdlib/fs/write-file]</span><span class="delimiter">: </span><span class="description">write data to a file.</span>
65-
66-
</div>
67-
68-
<!-- </toc> -->
69-
70-
Besides the aforementioned, it contains the following functions:
71-
72-
<!-- <toc keywords="-read, -write"> -->
73-
74-
<div class="namespace-toc">
75-
76-
- <span class="signature">[`exists( path, clbk )`][@stdlib/fs/exists]</span><span class="delimiter">: </span><span class="description">test whether a path exists on the filesystem.</span>
7752
- <span class="signature">[`rename( oldPath, newPath, clbk )`][@stdlib/fs/rename]</span><span class="delimiter">: </span><span class="description">rename a file.</span>
7853
- <span class="signature">[`resolveParentPath( path, [options,] clbk )`][@stdlib/fs/resolve-parent-path]</span><span class="delimiter">: </span><span class="description">resolve a path by walking parent directories.</span>
7954
- <span class="signature">[`unlink( path, clbk )`][@stdlib/fs/unlink]</span><span class="delimiter">: </span><span class="description">remove a directory entry.</span>
55+
- <span class="signature">[`writeFile( file, data, [options,] clbk )`][@stdlib/fs/write-file]</span><span class="delimiter">: </span><span class="description">write data to a file.</span>
8056

8157
</div>
8258

@@ -111,14 +87,6 @@ console.log( getKeys( fs ) );
11187

11288
[@stdlib/fs/exists]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/exists
11389

114-
[@stdlib/fs/rename]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/rename
115-
116-
[@stdlib/fs/resolve-parent-path]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/resolve-parent-path
117-
118-
[@stdlib/fs/unlink]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/unlink
119-
120-
[@stdlib/fs/write-file]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/write-file
121-
12290
[@stdlib/fs/read-dir]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/read-dir
12391

12492
[@stdlib/fs/read-file]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/read-file
@@ -129,6 +97,14 @@ console.log( getKeys( fs ) );
12997

13098
[@stdlib/fs/read-wasm]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/read-wasm
13199

100+
[@stdlib/fs/rename]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/rename
101+
102+
[@stdlib/fs/resolve-parent-path]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/resolve-parent-path
103+
104+
[@stdlib/fs/unlink]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/unlink
105+
106+
[@stdlib/fs/write-file]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/write-file
107+
132108
<!-- </toc-links> -->
133109

134110
</section>

0 commit comments

Comments
 (0)