Skip to content

Backport buffer added: info #7678

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
addaleax wants to merge 2 commits into from
Closed

Backport buffer added: info #7678

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82786ce
doc: add `added:` information for buffer
addaleax May 1, 2016
a978e9a
doc: remove `Buffer#includes` documentation
addaleax Jul 12, 2016
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
doc: remove Buffer#includes documentation 
The method is not available on v4.x, so it shouldn’t be in the docs.
  • Loading branch information
@addaleax
addaleax committed Jul 12, 2016
commit a978e9a770ef8bf403320734009657ddca55a087
33 changes: 0 additions & 33 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -916,39 +916,6 @@ utf16Buffer.indexOf('\u03a3', -4, 'ucs2');
// returns 6
```

### buf.includes(value[, byteOffset][, encoding])

* `value` {String|Buffer|Number}
* `byteOffset` {Number} Default: 0
* `encoding` {String} Default: `'utf8'`
* Return: {Boolean}

Operates similar to [`Array#includes()`][]. The `value` can be a String, Buffer
or Number. Strings are interpreted as UTF8 unless overridden with the
`encoding` argument. Buffers will use the entire Buffer (to compare a partial
Buffer use [`buf.slice()`][]). Numbers can range from 0 to 255.

The `byteOffset` indicates the index in `buf` where searching begins.

```js
const buf = new Buffer('this is a buffer');

buf.includes('this');
// returns true
buf.includes('is');
// returns true
buf.includes(new Buffer('a buffer'));
// returns true
buf.includes(97); // ascii for 'a'
// returns true
buf.includes(new Buffer('a buffer example'));
// returns false
buf.includes(new Buffer('a buffer example').slice(0,8));
// returns true
buf.includes('this', 4);
// returns false
```

### buf.keys()
<!-- YAML
added: v1.1.0
Expand Down