Skip to content

Commit

Permalink
doc: fix incorrect argument type in fs.readSync
Browse files Browse the repository at this point in the history
The `buffer` argument must be either Buffer or Uint8Array, string
values are not supported.

PR-URL: #18022
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
belochub authored and MylesBorins committed Jan 10, 2018
1 parent 1ad7df6 commit ffc2659
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2351,7 +2351,7 @@ changes:
-->

* `fd` {integer}
* `buffer` {string|Buffer|Uint8Array}
* `buffer` {Buffer|Uint8Array}
* `offset` {integer}
* `length` {integer}
* `position` {integer}
Expand Down

0 comments on commit ffc2659

Please sign in to comment.