1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: remove "note that" from buffer.md

Browse Source 
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/16

PR-URL: https://github.com/nodejs/node/pull/28329
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit is contained in:
Rich Trott 2019-06-20 14:08:13 -06:00
parent 287ed4c32d
commit 1b2f6d2d02
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/api/buffer.md
View File

@ -250,7 +250,7 @@ console.log(buf2);
// Prints: <Buffer 88 13 70 17> // Prints: <Buffer 88 13 70 17>
``` ```
Note that when creating a `Buffer` using a [`TypedArray`][]'s `.buffer`, it is When creating a `Buffer` using a [`TypedArray`][]'s `.buffer`, it is
possible to use only a portion of the underlying [`ArrayBuffer`][] by passing in possible to use only a portion of the underlying [`ArrayBuffer`][] by passing in
`byteOffset` and `length` parameters. `byteOffset` and `length` parameters.
@ -597,7 +597,7 @@ console.log(buf);
A `TypeError` will be thrown if `size` is not a number. A `TypeError` will be thrown if `size` is not a number.
Note that the `Buffer` module pre-allocates an internal `Buffer` instance of The `Buffer` module pre-allocates an internal `Buffer` instance of
size [`Buffer.poolSize`][] that is used as a pool for the fast allocation of new size [`Buffer.poolSize`][] that is used as a pool for the fast allocation of new
`Buffer` instances created using [`Buffer.allocUnsafe()`][] and the deprecated `Buffer` instances created using [`Buffer.allocUnsafe()`][] and the deprecated
`new Buffer(size)` constructor only when `size` is less than or equal to `new Buffer(size)` constructor only when `size` is less than or equal to
@ -1501,7 +1501,7 @@ added: v0.1.90
* {integer} * {integer}
Returns the amount of memory allocated for `buf` in bytes. Note that this Returns the amount of memory allocated for `buf` in bytes. This
does not necessarily reflect the amount of "usable" data within `buf`. does not necessarily reflect the amount of "usable" data within `buf`.
```js ```js
@ -2087,7 +2087,7 @@ buf2.swap64();
// Throws ERR_INVALID_BUFFER_SIZE. // Throws ERR_INVALID_BUFFER_SIZE.
``` ```
Note that JavaScript cannot encode 64-bit integers. This method is intended JavaScript cannot encode 64-bit integers. This method is intended
for working with 64-bit floats. for working with 64-bit floats.
### buf.toJSON() ### buf.toJSON()
@ -2623,7 +2623,7 @@ Returns the maximum number of bytes that will be returned when
`buf.inspect()` is called. This can be overridden by user modules. See `buf.inspect()` is called. This can be overridden by user modules. See
[`util.inspect()`][] for more details on `buf.inspect()` behavior. [`util.inspect()`][] for more details on `buf.inspect()` behavior.
Note that this is a property on the `buffer` module returned by This is a property on the `buffer` module returned by
`require('buffer')`, not on the `Buffer` global or a `Buffer` instance. `require('buffer')`, not on the `Buffer` global or a `Buffer` instance.
## buffer.kMaxLength ## buffer.kMaxLength
@ -2635,7 +2635,7 @@ added: v3.0.0
An alias for [`buffer.constants.MAX_LENGTH`][]. An alias for [`buffer.constants.MAX_LENGTH`][].
Note that this is a property on the `buffer` module returned by This is a property on the `buffer` module returned by
`require('buffer')`, not on the `Buffer` global or a `Buffer` instance. `require('buffer')`, not on the `Buffer` global or a `Buffer` instance.
## buffer.transcode(source, fromEnc, toEnc) ## buffer.transcode(source, fromEnc, toEnc)
@ -2675,7 +2675,7 @@ console.log(newBuf.toString('ascii'));
Because the Euro (`€`) sign is not representable in US-ASCII, it is replaced Because the Euro (`€`) sign is not representable in US-ASCII, it is replaced
with `?` in the transcoded `Buffer`. with `?` in the transcoded `Buffer`.
Note that this is a property on the `buffer` module returned by This is a property on the `buffer` module returned by
`require('buffer')`, not on the `Buffer` global or a `Buffer` instance. `require('buffer')`, not on the `Buffer` global or a `Buffer` instance.
## Class: SlowBuffer ## Class: SlowBuffer
@ -2753,7 +2753,7 @@ console.log(buf);
added: v8.2.0 added: v8.2.0
--> -->
Note that `buffer.constants` is a property on the `buffer` module returned by `buffer.constants` is a property on the `buffer` module returned by
`require('buffer')`, not on the `Buffer` global or a `Buffer` instance. `require('buffer')`, not on the `Buffer` global or a `Buffer` instance.
### buffer.constants.MAX_LENGTH ### buffer.constants.MAX_LENGTH