Skip to content

doc: make buffer.md more accurate #27030

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
vsemozhetbyt wants to merge 10 commits into from
Closed

doc: make buffer.md more accurate #27030

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e3d5d4d
doc: remove duplication in description
vsemozhetbyt Mar 30, 2019
ac2caec
doc: fix possible typo
vsemozhetbyt Mar 31, 2019
78f629a
doc: add missing types
vsemozhetbyt Mar 31, 2019
87d70b0
doc: unify number/integer types
vsemozhetbyt Mar 31, 2019
83052d2
doc: fix error notes in `Buffer.from()` variants
vsemozhetbyt Mar 30, 2019
142009e
doc: add note about Buffer octets integer coercion
vsemozhetbyt Mar 31, 2019
8b49feb
doc: mark optional parameters
vsemozhetbyt Mar 31, 2019
213fed4
doc: add notes about negative offsets
vsemozhetbyt Mar 31, 2019
fbf4c70
doc: unify periods in comments
vsemozhetbyt Mar 30, 2019
56da51a
doc: unify link formatting
vsemozhetbyt Mar 31, 2019
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
Next Next commit
doc: add notes about negative offsets
  • Loading branch information
@vsemozhetbyt
vsemozhetbyt committed Apr 2, 2019
commit 213fed4c3453df109da658557b356235d2a14d85
11 changes: 7 additions & 4 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1281,7 +1281,8 @@ added: v5.3.0
-->

* `value` {string|Buffer|Uint8Array|integer} What to search for.
* `byteOffset` {integer} Where to begin searching in `buf`. **Default:** `0`.
* `byteOffset` {integer} Where to begin searching in `buf`. If negative, then
offset is calculated from the end of `buf`. **Default:** `0`.
* `encoding` {string} If `value` is a string, this is its encoding.
**Default:** `'utf8'`.
* Returns: {boolean} `true` if `value` was found in `buf`, `false` otherwise.
Expand Down Expand Up @@ -1321,7 +1322,8 @@ changes:
-->

* `value` {string|Buffer|Uint8Array|integer} What to search for.
* `byteOffset` {integer} Where to begin searching in `buf`. **Default:** `0`.
* `byteOffset` {integer} Where to begin searching in `buf`. If negative, then
offset is calculated from the end of `buf`. **Default:** `0`.
* `encoding` {string} If `value` is a string, this is the encoding used to
determine the binary representation of the string that will be searched for in
`buf`. **Default:** `'utf8'`.
Expand Down Expand Up @@ -1423,8 +1425,9 @@ changes:
-->

* `value` {string|Buffer|Uint8Array|integer} What to search for.
* `byteOffset` {integer} Where to begin searching in `buf`.
**Default:** [`buf.length`]` - 1`.
* `byteOffset` {integer} Where to begin searching in `buf`. If negative, then
offset is calculated from the end of `buf`. **Default:**
[`buf.length`]` - 1`.
* `encoding` {string} If `value` is a string, this is the encoding used to
determine the binary representation of the string that will be searched for in
`buf`. **Default:** `'utf8'`.
Expand Down