Skip to content

[v14.x backport] doc: refactor fs docs structure #39706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
targos wants to merge 6 commits into from
Closed

[v14.x backport] doc: refactor fs docs structure #39706

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2ed0c3f
squash: make fs.md identical to master
targos Aug 8, 2021
136c98d
squash: restore lost changes entry in dgram.md
targos Aug 8, 2021
6a5c4c5
doc: refactor fs docs structure
jasnell Feb 1, 2021
29dafe9
squash: revert bad changes from d96326935ba939bfcd18c4cac525dd108a54032c
targos Aug 8, 2021
e912108
doc: change lang info string in fs JS snippets
aduh95 Mar 4, 2021
2f751eb
Apply suggestions from code review
targos Sep 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Apply suggestions from code review 
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
  • Loading branch information
@targos @aduh95
targos and aduh95 authored Sep 1, 2021
commit 2f751eb8e2d9d663dfc1a74e345fbc6e67484036
16 changes: 12 additions & 4 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,9 @@ of the file.

#### `filehandle.readv(buffers[, position])`
<!-- YAML
added: v14.0.0
added:
- v13.13.0
- v12.17.0
-->

* `buffers` {Buffer[]|TypedArray[]|DataView[]}
Expand Down Expand Up @@ -4566,9 +4568,13 @@ this API: [`fs.read()`][].

### `fs.readSync(fd, buffer, [options])`
<!-- YAML
added: v14.0.0
added:
- v13.13.0
- v12.17.0
changes:
- version: v14.0.0
- version:
- v13.13.0
- v12.17.0
pr-url: https://github.com/nodejs/node/pull/32460
description: Options object can be passed in
to make offset, length and position optional.
Expand All @@ -4592,7 +4598,9 @@ this API: [`fs.read()`][].

### `fs.readvSync(fd, buffers[, position])`
<!-- YAML
added: v14.0.0
added:
- v13.13.0
- v12.17.0
-->

* `fd` {integer}
Expand Down