Browse Source

doc: use Buffer.from() instead of new Buffer()

Use new API of Buffer to developers in most documents.

PR-URL: https://github.com/nodejs/node/pull/6367
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
process-exit-stdio-flushing
Jackson Tian 9 years ago
parent
commit
e556dd3856
  1. 2
      doc/api/crypto.md
  2. 6
      doc/api/dgram.md
  3. 4
      doc/api/stream.md
  4. 4
      doc/api/string_decoder.md
  5. 2
      doc/api/util.md
  6. 4
      doc/api/zlib.md
  7. 4
      lib/string_decoder.js

2
doc/api/crypto.md

@ -93,7 +93,7 @@ The `spkac` argument must be a Node.js [`Buffer`][].
```js ```js
const cert = require('crypto').Certificate(); const cert = require('crypto').Certificate();
const spkac = getSpkacSomehow(); const spkac = getSpkacSomehow();
console.log(cert.verifySpkac(new Buffer(spkac))); console.log(cert.verifySpkac(Buffer.from(spkac)));
// Prints true or false // Prints true or false
``` ```

6
doc/api/dgram.md

@ -233,7 +233,7 @@ Example of sending a UDP packet to a random port on `localhost`;
```js ```js
const dgram = require('dgram'); const dgram = require('dgram');
const message = new Buffer('Some bytes'); const message = Buffer.from('Some bytes');
const client = dgram.createSocket('udp4'); const client = dgram.createSocket('udp4');
client.send(message, 41234, 'localhost', (err) => { client.send(message, 41234, 'localhost', (err) => {
client.close(); client.close();
@ -244,8 +244,8 @@ Example of sending a UDP packet composed of multiple buffers to a random port on
```js ```js
const dgram = require('dgram'); const dgram = require('dgram');
const buf1 = new Buffer('Some '); const buf1 = Buffer.from('Some ');
const buf2 = new Buffer('bytes'); const buf2 = Buffer.from('bytes');
const client = dgram.createSocket('udp4'); const client = dgram.createSocket('udp4');
client.send([buf1, buf2], 41234, 'localhost', (err) => { client.send([buf1, buf2], 41234, 'localhost', (err) => {
client.close(); client.close();

4
doc/api/stream.md

@ -490,7 +490,7 @@ function parseHeader(stream, callback) {
var split = str.split(/\n\n/); var split = str.split(/\n\n/);
header += split.shift(); header += split.shift();
var remaining = split.join('\n\n'); var remaining = split.join('\n\n');
var buf = new Buffer(remaining, 'utf8'); var buf = Buffer.from(remaining, 'utf8');
if (buf.length) if (buf.length)
stream.unshift(buf); stream.unshift(buf);
stream.removeListener('error', callback); stream.removeListener('error', callback);
@ -985,7 +985,7 @@ Counter.prototype._read = function() {
this.push(null); this.push(null);
else { else {
var str = '' + i; var str = '' + i;
var buf = new Buffer(str, 'ascii'); var buf = Buffer.from(str, 'ascii');
this.push(buf); this.push(buf);
} }
}; };

4
doc/api/string_decoder.md

@ -10,10 +10,10 @@ additional support for utf8.
const StringDecoder = require('string_decoder').StringDecoder; const StringDecoder = require('string_decoder').StringDecoder;
const decoder = new StringDecoder('utf8'); const decoder = new StringDecoder('utf8');
const cent = new Buffer([0xC2, 0xA2]); const cent = Buffer.from([0xC2, 0xA2]);
console.log(decoder.write(cent)); console.log(decoder.write(cent));
const euro = new Buffer([0xE2, 0x82, 0xAC]); const euro = Buffer.from([0xE2, 0x82, 0xAC]);
console.log(decoder.write(euro)); console.log(decoder.write(euro));
``` ```

2
doc/api/util.md

@ -297,7 +297,7 @@ util.isBuffer({ length: 0 })
// false // false
util.isBuffer([]) util.isBuffer([])
// false // false
util.isBuffer(new Buffer('hello world')) util.isBuffer(Buffer.from('hello world'))
// true // true
``` ```

4
doc/api/zlib.md

@ -37,7 +37,7 @@ zlib.deflate(input, (err, buffer) => {
} }
}); });
const buffer = new Buffer('eJzT0yMAAGTvBe8=', 'base64'); const buffer = Buffer.from('eJzT0yMAAGTvBe8=', 'base64');
zlib.unzip(buffer, (err, buffer) => { zlib.unzip(buffer, (err, buffer) => {
if (!err) { if (!err) {
console.log(buffer.toString()); console.log(buffer.toString());
@ -117,7 +117,7 @@ method that is used to compressed the last chunk of input data:
```js ```js
// This is a truncated version of the buffer from the above examples // This is a truncated version of the buffer from the above examples
const buffer = new Buffer('eJzT0yMA', 'base64'); const buffer = Buffer.from('eJzT0yMA', 'base64');
zlib.unzip(buffer, { finishFlush: zlib.Z_SYNC_FLUSH }, (err, buffer) => { zlib.unzip(buffer, { finishFlush: zlib.Z_SYNC_FLUSH }, (err, buffer) => {
if (!err) { if (!err) {

4
lib/string_decoder.js

@ -58,8 +58,8 @@ const StringDecoder = exports.StringDecoder = function(encoding) {
// returned when calling write again with the remaining bytes. // returned when calling write again with the remaining bytes.
// //
// Note: Converting a Buffer containing an orphan surrogate to a String // Note: Converting a Buffer containing an orphan surrogate to a String
// currently works, but converting a String to a Buffer (via `new Buffer`, or // currently works, but converting a String to a Buffer (via `Buffer.from()`,
// Buffer#write) will replace incomplete surrogates with the unicode // or Buffer#write) will replace incomplete surrogates with the unicode
// replacement character. See https://codereview.chromium.org/121173009/ . // replacement character. See https://codereview.chromium.org/121173009/ .
StringDecoder.prototype.write = function(buffer) { StringDecoder.prototype.write = function(buffer) {
var charStr = ''; var charStr = '';

Loading…
Cancel
Save