Node.js v16.13.0 文档


目录

buffer 缓冲区#

中英对照

稳定性: 2 - 稳定

源代码: lib/buffer.js

Buffer 对象用于表示固定长度的字节序列。 许多 Node.js API 都支持 Buffer

Buffer 类是 JavaScript Uint8Array 类的子类,并使用涵盖额外用例的方法对其进行扩展。 Node.js API 在支持 Buffer 的地方也接受普通的 Uint8Array

虽然 Buffer 类在全局作用域内可用,但仍然建议通过 import 或 require 语句显式地引用它。

import { Buffer } from 'buffer';

// 创建长度为 10 的以零填充的缓冲区。
const buf1 = Buffer.alloc(10);

// 创建长度为 10 的缓冲区,
// 使用值为 `1` 的字节填充。
const buf2 = Buffer.alloc(10, 1);

// 创建长度为 10 的未初始化的缓冲区。
// 这比调用 Buffer.alloc() 快,
// 但返回的缓冲区实例可能包含旧数据,
// 需要使用 fill()、write() 、
// 或其他填充缓冲区内容的函数重写。
const buf3 = Buffer.allocUnsafe(10);

// 创建包含字节 [1, 2, 3] 的缓冲区。
const buf4 = Buffer.from([1, 2, 3]);

// 创建包含字节 [1, 1, 1, 1] 的缓冲区,
// 所有条目都使用 `(value & 255)` 截断以符合范围 0–255。
const buf5 = Buffer.from([257, 257.5, -255, '1']);

// 创建包含字符串 'tést' 的 UTF-8 编码字节的缓冲区:
// [0x74, 0xc3, 0xa9, 0x73, 0x74](十六进制)
// [116, 195, 169, 115, 116](十进制)
const buf6 = Buffer.from('tést');

// 创建包含 Latin-1 字节 [0x74, 0xe9, 0x73, 0x74] 的缓冲区。
const buf7 = Buffer.from('tést', 'latin1');const { Buffer } = require('buffer');

// 创建长度为 10 的以零填充的缓冲区。
const buf1 = Buffer.alloc(10);

// 创建长度为 10 的缓冲区,
// 使用值为 `1` 的字节填充。
const buf2 = Buffer.alloc(10, 1);

// 创建长度为 10 的未初始化的缓冲区。
// 这比调用 Buffer.alloc() 快,
// 但返回的缓冲区实例可能包含旧数据,
// 需要使用 fill()、write() 、
// 或其他填充缓冲区内容的函数重写。
const buf3 = Buffer.allocUnsafe(10);

// 创建包含字节 [1, 2, 3] 的缓冲区。
const buf4 = Buffer.from([1, 2, 3]);

// 创建包含字节 [1, 1, 1, 1] 的缓冲区,
// 所有条目都使用 `(value & 255)` 截断以符合范围 0–255。
const buf5 = Buffer.from([257, 257.5, -255, '1']);

// 创建包含字符串 'tést' 的 UTF-8 编码字节的缓冲区:
// [0x74, 0xc3, 0xa9, 0x73, 0x74](十六进制)
// [116, 195, 169, 115, 116](十进制)
const buf6 = Buffer.from('tést');

// 创建包含 Latin-1 字节 [0x74, 0xe9, 0x73, 0x74] 的缓冲区。
const buf7 = Buffer.from('tést', 'latin1');

缓冲区与字符编码#

中英对照

当在 Buffer 和字符串之间进行转换时,可以指定字符编码。 如果未指定字符编码,则默认使用 UTF-8。

import { Buffer } from 'buffer';

const buf = Buffer.from('hello world', 'utf8');

console.log(buf.toString('hex'));
// 打印: 68656c6c6f20776f726c64
console.log(buf.toString('base64'));
// 打印: aGVsbG8gd29ybGQ=

console.log(Buffer.from('fhqwhgads', 'utf8'));
// 打印: <Buffer 66 68 71 77 68 67 61 64 73>
console.log(Buffer.from('fhqwhgads', 'utf16le'));
// 打印: <Buffer 66 00 68 00 71 00 77 00 68 00 67 00 61 00 64 00 73 00>const { Buffer } = require('buffer');

const buf = Buffer.from('hello world', 'utf8');

console.log(buf.toString('hex'));
// 打印: 68656c6c6f20776f726c64
console.log(buf.toString('base64'));
// 打印: aGVsbG8gd29ybGQ=

console.log(Buffer.from('fhqwhgads', 'utf8'));
// 打印: <Buffer 66 68 71 77 68 67 61 64 73>
console.log(Buffer.from('fhqwhgads', 'utf16le'));
// 打印: <Buffer 66 00 68 00 71 00 77 00 68 00 67 00 61 00 64 00 73 00>

Node.js 缓冲区接受它们接收到的编码字符串的所有大小写变体。 例如,UTF-8 可以指定为 'utf8''UTF8''uTf8'

Node.js 目前支持的字符编码如下:

  • 'utf8'(别名:'utf-8'):多字节编码的 Unicode 字符。 许多网页和其他文档格式使用 UTF-8。 这是默认的字符编码。 当将 Buffer 解码为不完全包含有效 UTF-8 数据的字符串时,则 Unicode 替换字符 U+FFFD � 将用于表示这些错误。

  • 'utf16le'(别名:'utf-16le'):多字节编码的 Unicode 字符。 与 'utf8' 不同,字符串中的每个字符都将使用 2 或 4 个字节进行编码。 Node.js 仅支持 UTF-16小端序变体。

  • 'latin1': Latin-1 代表 ISO-8859-1。 此字符编码仅支持 U+0000U+00FF 的 Unicode 字符。 每个字符都使用单个字节进行编码。 不符合该范围的字符将被截断并映射到该范围内的字符。

使用以上编码之一将 Buffer 转换为字符串称为解码,将字符串转换为 Buffer 称为编码。

Node.js 还支持以下二进制转文本的编码。 对于二进制转文本的编码,命名约定是相反的:将 Buffer 转换为字符串通常称为编码,将字符串转换为 Buffer 通常称为解码。

  • 'base64': Base64 编码。 当从字符串创建 Buffer 时,此编码还将正确接受 RFC 4648,第 5 节中指定的 "URL 和文件名安全字母表"。 base64 编码的字符串中包含的空白字符(例如空格、制表符和换行符)会被忽略。

  • 'base64url': base64url 编码如 RFC 4648 第 5 节中指定。 当从字符串创建 Buffer 时,此编码也将正确接受常规的 base64 编码的字符串。 当将 Buffer 编码为字符串时,此编码将忽略填充。

  • 'hex': 将每个字节编码为两个十六进制字符。 当解码仅包含有效十六进制字符的字符串时,可能会发生数据截断。 请参阅下面的示例。

还支持以下旧版字符编码:

  • 'ascii': 仅适用于 7 位 ASCII 数据。 当将字符串编码为 Buffer 时,这等效于使用 'latin1'。 当将 Buffer 解码为字符串时,使用此编码将在解码为 'latin1' 之前额外取消设置每个字节的最高位。 通常,没有理由使用此编码,因为在编码或解码纯 ASCII 文本时,'utf8'(或者,如果已知数据始终是纯 ASCII,则为 'latin1')将是更好的选择。 它仅用于旧版兼容性。

  • 'binary': 'latin1' 的别名。 有关此主题的更多背景信息,请参阅二进制字符串。 此编码的名称很容易让人误解,因为这里列出的所有编码都在字符串和二进制数据之间进行转换。 对于字符串和 Buffer 之间的转换,通常 'utf8' 是正确的选择。

  • 'ucs2', 'ucs-2': 'utf16le' 的别名。 UCS-2 过去指的是 UTF-16 的一种变体,它不支持代码点大于 U+FFFF 的字符。 在 Node.js 中,始终支持这些代码点。

import { Buffer } from 'buffer';

Buffer.from('1ag', 'hex');
// 打印 <Buffer 1a>,当遇到第一个非十六进制值 ('g') 时,则截断数据。

Buffer.from('1a7g', 'hex');
// 打印 <Buffer 1a>,当数据以一位数 ('7') 结尾时,则截断数据。

Buffer.from('1634', 'hex');
// 打印 <Buffer 16 34>,表现所有数据。const { Buffer } = require('buffer');

Buffer.from('1ag', 'hex');
// 打印 <Buffer 1a>,当遇到第一个非十六进制值 ('g') 时,则截断数据。

Buffer.from('1a7g', 'hex');
// 打印 <Buffer 1a>,当数据以一位数 ('7') 结尾时,则截断数据。

Buffer.from('1634', 'hex');
// 打印 <Buffer 16 34>,表现所有数据。

现代 Web 浏览器遵循 WHATWG 编码标准,其将 'latin1''ISO-8859-1' 别名为 'win-1252'。 这意味着在执行 http.get() 之类的操作时,如果返回的字符集是 WHATWG 规范中列出的字符集之一,则服务器实际上可能返回 'win-1252' 编码的数据,使用 'latin1' 编码可能会错误地解码字符。

缓冲区与 TypedArray#

中英对照

Buffer 实例也是 JavaScript Uint8ArrayTypedArray 实例。 所有 TypedArray 方法都可在 Buffer 上使用。 但是,Buffer API 和 TypedArray API 之间存在细微的不兼容。

特别是:

有两种方式可以从 Buffer 创建新的 TypedArray 实例:

  • Buffer 传给 TypedArray 构造函数将复制 Buffer 的内容,解释为整数数组,而不是目标类型的字节序列。
import { Buffer } from 'buffer';

const buf = Buffer.from([1, 2, 3, 4]);
const uint32array = new Uint32Array(buf);

console.log(uint32array);

// 打印: Uint32Array(4) [ 1, 2, 3, 4 ]const { Buffer } = require('buffer');

const buf = Buffer.from([1, 2, 3, 4]);
const uint32array = new Uint32Array(buf);

console.log(uint32array);

// 打印: Uint32Array(4) [ 1, 2, 3, 4 ]
import { Buffer } from 'buffer';

const buf = Buffer.from('hello', 'utf16le');
const uint16array = new Uint16Array(
  buf.buffer,
  buf.byteOffset,
  buf.length / Uint16Array.BYTES_PER_ELEMENT);

console.log(uint16array);

// 打印: Uint16Array(5) [ 104, 101, 108, 108, 111 ]const { Buffer } = require('buffer');

const buf = Buffer.from('hello', 'utf16le');
const uint16array = new Uint16Array(
  buf.buffer,
  buf.byteOffset,
  buf.length / Uint16Array.BYTES_PER_ELEMENT);

console.log(uint16array);

// 打印: Uint16Array(5) [ 104, 101, 108, 108, 111 ]

通过以相同的方式使用 TypedArray 对象的 .buffer 属性,可以创建新的 Buffer,它与 TypedArray 实例共享相同的分配内存。 Buffer.from() 在这种情况下表现得像 new Uint8Array()

import { Buffer } from 'buffer';

const arr = new Uint16Array(2);

arr[0] = 5000;
arr[1] = 4000;

// 复制 `arr` 的内容。
const buf1 = Buffer.from(arr);

// 与 `arr` 共享内存。
const buf2 = Buffer.from(arr.buffer);

console.log(buf1);
// 打印: <Buffer 88 a0>
console.log(buf2);
// 打印: <Buffer 88 13 a0 0f>

arr[1] = 6000;

console.log(buf1);
// 打印: <Buffer 88 a0>
console.log(buf2);
// 打印: <Buffer 88 13 70 17>const { Buffer } = require('buffer');

const arr = new Uint16Array(2);

arr[0] = 5000;
arr[1] = 4000;

// 复制 `arr` 的内容。
const buf1 = Buffer.from(arr);

// 与 `arr` 共享内存。
const buf2 = Buffer.from(arr.buffer);

console.log(buf1);
// 打印: <Buffer 88 a0>
console.log(buf2);
// 打印: <Buffer 88 13 a0 0f>

arr[1] = 6000;

console.log(buf1);
// 打印: <Buffer 88 a0>
console.log(buf2);
// 打印: <Buffer 88 13 70 17>

使用 TypedArray.buffer 创建 Buffer 时,可以通过传入 byteOffsetlength 参数仅使用底层 ArrayBuffer 的一部分。

import { Buffer } from 'buffer';

const arr = new Uint16Array(20);
const buf = Buffer.from(arr.buffer, 0, 16);

console.log(buf.length);
// 打印: 16const { Buffer } = require('buffer');

const arr = new Uint16Array(20);
const buf = Buffer.from(arr.buffer, 0, 16);

console.log(buf.length);
// 打印: 16

Buffer.from()TypedArray.from() 具有不同的签名和实现。 具体来说,TypedArray 变体接受第二个参数,该参数是在类型化数组的每个元素上调用的映射函数:

  • TypedArray.from(source[, mapFn[, thisArg]])

但是,Buffer.from() 方法不支持使用映射函数:

缓冲区与迭代器#

中英对照

可以使用 for..of 语法迭代 Buffer 实例:

import { Buffer } from 'buffer';

const buf = Buffer.from([1, 2, 3]);

for (const b of buf) {
  console.log(b);
}
// 打印:
//   1
//   2
//   3const { Buffer } = require('buffer');

const buf = Buffer.from([1, 2, 3]);

for (const b of buf) {
  console.log(b);
}
// 打印:
//   1
//   2
//   3

此外,buf.values()buf.keys()buf.entries() 方法可用于创建迭代器。

Blob#

中英对照

稳定性: 1 - 实验

Blob 封装了不可变的原始数据,可以在多个工作线程之间安全地共享。

new buffer.Blob([sources[, options]])#

中英对照

创建新的 Blob 对象,其中包含给定源的串接。

<ArrayBuffer><TypedArray><DataView><Buffer> 源被复制到 'Blob' 中,因此可以在创建 'Blob' 后安全地修改。

字符串源被编码为 UTF-8 字节序列并复制到 Blob 中。 每个字符串部分中不匹配的代理对将被 Unicode U+FFFD 替换字符替换。

blob.arrayBuffer()#

中英对照

返回使用包含 Blob 数据副本的 <ArrayBuffer> 履行的 promise。

blob.size#

中英对照

Blob 的总大小(以字节为单位)。

blob.slice([start, [end, [type]]])#

中英对照

创建并返回包含此 Blob 对象数据子集的新 Blob。 原 Blob 没有改动。

blob.stream()#

中英对照

返回允许读取 Blob 内容的新 ReadableStream

blob.text()#

中英对照

返回使用解码为 UTF-8 字符串的 Blob 的内容履行的 promise。

blob.type#

中英对照

Blob 的内容类型。

Blob 对象和 MessageChannel#

中英对照

一旦创建了 <Blob> 对象,就可以通过 MessagePort 将其发送到多个目的地,而无需传输或立即复制数据。 只有在调用 arrayBuffer()text() 方法时才会复制 Blob 包含的数据。

import { Blob, Buffer } from 'buffer';
import { setTimeout as delay } from 'timers/promises';

const blob = new Blob(['hello there']);

const mc1 = new MessageChannel();
const mc2 = new MessageChannel();

mc1.port1.onmessage = async ({ data }) => {
  console.log(await data.arrayBuffer());
  mc1.port1.close();
};

mc2.port1.onmessage = async ({ data }) => {
  await delay(1000);
  console.log(await data.arrayBuffer());
  mc2.port1.close();
};

mc1.port2.postMessage(blob);
mc2.port2.postMessage(blob);

// 发布后 Blob 仍然可用。
blob.text().then(console.log);const { Blob, Buffer } = require('buffer');
const { setTimeout: delay } = require('timers/promises');

const blob = new Blob(['hello there']);

const mc1 = new MessageChannel();
const mc2 = new MessageChannel();

mc1.port1.onmessage = async ({ data }) => {
  console.log(await data.arrayBuffer());
  mc1.port1.close();
};

mc2.port1.onmessage = async ({ data }) => {
  await delay(1000);
  console.log(await data.arrayBuffer());
  mc2.port1.close();
};

mc1.port2.postMessage(blob);
mc2.port2.postMessage(blob);

// 发布后 Blob 仍然可用。
blob.text().then(console.log);

Buffer#

中英对照

Buffer 类是直接处理二进制数据的全局类型。 它可以使用多种方式构建。

Buffer.alloc(size[, fill[, encoding]])#

中英对照

分配 size 个字节的新 Buffer。 如果 fillundefined,则 Buffer 将以零填充。

import { Buffer } from 'buffer';

const buf = Buffer.alloc(5);

console.log(buf);
// 打印: <Buffer 00 00 00 00 00>const { Buffer } = require('buffer');

const buf = Buffer.alloc(5);

console.log(buf);
// 打印: <Buffer 00 00 00 00 00>

如果 size 大于 buffer.constants.MAX_LENGTH 或小于 0,则抛出 ERR_INVALID_ARG_VALUE

如果指定了 fill,则分配的 Buffer 将通过调用 buf.fill(fill) 进行初始化。

import { Buffer } from 'buffer';

const buf = Buffer.alloc(5, 'a');

console.log(buf);
// 打印: <Buffer 61 61 61 61 61>const { Buffer } = require('buffer');

const buf = Buffer.alloc(5, 'a');

console.log(buf);
// 打印: <Buffer 61 61 61 61 61>

如果同时指定了 fillencoding,则分配的 Buffer 将通过调用 buf.fill(fill, encoding) 进行初始化。

import { Buffer } from 'buffer';

const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');

console.log(buf);
// 打印: <Buffer 68 65 6c 6c 6f 20 77 6f 72 6c 64>const { Buffer } = require('buffer');

const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');

console.log(buf);
// 打印: <Buffer 68 65 6c 6c 6f 20 77 6f 72 6c 64>

调用 Buffer.alloc() 可能比替代的 Buffer.allocUnsafe() 慢得多,但可确保新创建的 Buffer 实例的内容永远不会包含来自先前分配的敏感数据,包括可能尚未分配给 Buffer 的数据。

如果 size 不是数值,则会抛出 TypeError

Buffer.allocUnsafe(size)#

中英对照

  • size <integer> 新的 Buffer 所需的长度。

分配 size 个字节的新 Buffer。 如果 size 大于 buffer.constants.MAX_LENGTH 或小于 0,则抛出 ERR_INVALID_ARG_VALUE

以这种方式创建的 Buffer 实例的底层内存不会被初始化。 新创建的 Buffer 的内容是未知的,可能包含敏感的数据。 使用 Buffer.alloc() 来用零初始化 Buffer 实例。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(10);

console.log(buf);
// 打印(内容可能会有所不同): <Buffer a0 8b 28 3f 01 00 00 00 50 32>

buf.fill(0);

console.log(buf);
// 打印: <Buffer 00 00 00 00 00 00 00 00 00 00>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(10);

console.log(buf);
// 打印(内容可能会有所不同): <Buffer a0 8b 28 3f 01 00 00 00 50 32>

buf.fill(0);

console.log(buf);
// 打印: <Buffer 00 00 00 00 00 00 00 00 00 00>

如果 size 不是数值,则会抛出 TypeError

Buffer 模块预先分配了大小为 Buffer.poolSize 的内部 Buffer 实例作为池,用于快速分配使用 Buffer.allocUnsafe()Buffer.from(array)Buffer.concat() 创建的新 Buffer 实例,仅当 size 小于或等于 Buffer.poolSize >> 1Buffer.poolSize 除以二再向下取整)时才使用弃用的 new Buffer(size) 构造函数。

使用此预先分配的内部内存池是调用 Buffer.alloc(size, fill) 与调用 Buffer.alloc(size, fill) 之间的关键区别。 具体来说,Buffer.alloc(size, fill) 永远不会使用内部 Buffer 池,而 Buffer.allocUnsafe(size).fill(fill) 会在 size 小于或等于 Buffer.poolSize 的一半时使用内部 Buffer 池。 当应用程序需要 Buffer.allocUnsafe() 提供的额外性能时,差异很细微,但可能很重要。

Buffer.allocUnsafeSlow(size)#

中英对照

  • size <integer> 新的 Buffer 所需的长度。

分配 size 个字节的新 Buffer。 如果 size 大于 buffer.constants.MAX_LENGTH 或小于 0,则抛出 ERR_INVALID_ARG_VALUE。 如果 size 为 0,则创建零长度 Buffer

以这种方式创建的 Buffer 实例的底层内存不会被初始化。 新创建的 Buffer 的内容是未知的,可能包含敏感的数据。 使用 buf.fill(0) 用零初始化此类 Buffer 实例。

当使用 Buffer.allocUnsafe() 分配新的 Buffer 实例时,4 KB 以下的分配将从单个预先分配的 Buffer 中切分。 这允许应用程序避免创建许多单独分配的 Buffer 实例的垃圾收集开销。 这种方法无需跟踪和清理尽可能多的单个 ArrayBuffer 对象,从而提高了性能和内存使用率。

但是,在开发人员可能需要在不确定的时间内从池中保留一小块内存的情况下,使用 Buffer.allocUnsafeSlow() 创建未池化的 Buffer 实例然后复制出相关位可能是合适的。

import { Buffer } from 'buffer';

// 需要保留一些小块内存。
const store = [];

socket.on('readable', () => {
  let data;
  while (null !== (data = readable.read())) {
    // 为保留的数据分配。
    const sb = Buffer.allocUnsafeSlow(10);

    // 将数据复制到新分配中。
    data.copy(sb, 0, 0, 10);

    store.push(sb);
  }
});const { Buffer } = require('buffer');

// 需要保留一些小块内存。
const store = [];

socket.on('readable', () => {
  let data;
  while (null !== (data = readable.read())) {
    // 为保留的数据分配。
    const sb = Buffer.allocUnsafeSlow(10);

    // 将数据复制到新分配中。
    data.copy(sb, 0, 0, 10);

    store.push(sb);
  }
});

如果 size 不是数值,则会抛出 TypeError

Buffer.byteLength(string[, encoding])#

中英对照

使用 encoding 编码时返回字符串的字节长度。 这与 String.prototype.length 不同,String.prototype.length 不考虑用于将字符串转换为字节的编码。

对于 'base64''base64url''hex',此函数假定输入有效。 对于包含非 base64/hex 编码数据(例如空格)的字符串,返回值可能大于从字符串创建的 Buffer 的长度。

import { Buffer } from 'buffer';

const str = '\u00bd + \u00bc = \u00be';

console.log(`${str}: ${str.length} characters, ` +
            `${Buffer.byteLength(str, 'utf8')} bytes`);
// 打印: ½ + ¼ = ¾: 9 characters, 12 bytesconst { Buffer } = require('buffer');

const str = '\u00bd + \u00bc = \u00be';

console.log(`${str}: ${str.length} characters, ` +
            `${Buffer.byteLength(str, 'utf8')} bytes`);
// 打印: ½ + ¼ = ¾: 9 characters, 12 bytes

stringBuffer/DataView/TypedArray/ArrayBuffer/SharedArrayBuffer 时,返回 .byteLength 报告的字节长度。

Buffer.compare(buf1, buf2)#

中英对照

比较 buf1buf2,通常用于对 Buffer 实例的数组进行排序。 这相当于调用 buf1.compare(buf2)

import { Buffer } from 'buffer';

const buf1 = Buffer.from('1234');
const buf2 = Buffer.from('0123');
const arr = [buf1, buf2];

console.log(arr.sort(Buffer.compare));
// 打印: [ <Buffer 30 31 32 33>, <Buffer 31 32 33 34> ]
// (此结果相当于:[buf2, buf1]。)const { Buffer } = require('buffer');

const buf1 = Buffer.from('1234');
const buf2 = Buffer.from('0123');
const arr = [buf1, buf2];

console.log(arr.sort(Buffer.compare));
// 打印: [ <Buffer 30 31 32 33>, <Buffer 31 32 33 34> ]
// (此结果相当于:[buf2, buf1]。)

Buffer.concat(list[, totalLength])#

中英对照

返回新的 Buffer,它是将 list 中的所有 Buffer 实例连接在一起的结果。

如果列表没有条目,或者 totalLength 为 0,则返回新的零长度 Buffer

如果未提供 totalLength,则从 list 中的 Buffer 实例通过相加其长度来计算。

如果提供了 totalLength,则将其强制为无符号整数。 如果 listBuffer 的组合长度超过 totalLength,则结果截断为 totalLength

import { Buffer } from 'buffer';

// 从三个 `Buffer` 实例的列表创建单个 `Buffer`。

const buf1 = Buffer.alloc(10);
const buf2 = Buffer.alloc(14);
const buf3 = Buffer.alloc(18);
const totalLength = buf1.length + buf2.length + buf3.length;

console.log(totalLength);
// 打印: 42

const bufA = Buffer.concat([buf1, buf2, buf3], totalLength);

console.log(bufA);
// 打印: <Buffer 00 00 00 00 ...>
console.log(bufA.length);
// 打印: 42const { Buffer } = require('buffer');

// 从三个 `Buffer` 实例的列表创建单个 `Buffer`。

const buf1 = Buffer.alloc(10);
const buf2 = Buffer.alloc(14);
const buf3 = Buffer.alloc(18);
const totalLength = buf1.length + buf2.length + buf3.length;

console.log(totalLength);
// 打印: 42

const bufA = Buffer.concat([buf1, buf2, buf3], totalLength);

console.log(bufA);
// 打印: <Buffer 00 00 00 00 ...>
console.log(bufA.length);
// 打印: 42

Buffer.concat() 也像 Buffer.allocUnsafe() 一样使用内部 Buffer 池。

Buffer.from(array)#

中英对照

使用 0255 范围内的字节 array 分配新的 Buffer。 该范围之外的数组条目将被截断以符合它。

import { Buffer } from 'buffer';

// 创建包含字符串 'buffer' 的 UTF-8 字节的新缓冲区。
const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);const { Buffer } = require('buffer');

// 创建包含字符串 'buffer' 的 UTF-8 字节的新缓冲区。
const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);

如果 array 不是 Array 或其他适用于 Buffer.from() 变体的类型,则将抛出 TypeError

Buffer.from(array)Buffer.from(string) 也像 Buffer.allocUnsafe() 一样使用内部 Buffer 池。

Buffer.from(arrayBuffer[, byteOffset[, length]])#

中英对照

这将创建 ArrayBuffer 的视图,而无需复制底层内存。 例如,当传入对 TypedArray 实例的 .buffer 属性的引用时,新创建的 Buffer 将与 TypedArray 的底层 ArrayBuffer 共享相同的分配内存。

import { Buffer } from 'buffer';

const arr = new Uint16Array(2);

arr[0] = 5000;
arr[1] = 4000;

// 与 `arr` 共享内存。
const buf = Buffer.from(arr.buffer);

console.log(buf);
// 打印: <Buffer 88 13 a0 0f>

// 更改原始的 Uint16Array 也会更改缓冲区。
arr[1] = 6000;

console.log(buf);
// 打印: <Buffer 88 13 70 17>const { Buffer } = require('buffer');

const arr = new Uint16Array(2);

arr[0] = 5000;
arr[1] = 4000;

// 与 `arr` 共享内存。
const buf = Buffer.from(arr.buffer);

console.log(buf);
// 打印: <Buffer 88 13 a0 0f>

// 更改原始的 Uint16Array 也会更改缓冲区。
arr[1] = 6000;

console.log(buf);
// 打印: <Buffer 88 13 70 17>

可选的 byteOffsetlength 参数指定了 arrayBuffer 中将由 Buffer 共享的内存范围。

import { Buffer } from 'buffer';

const ab = new ArrayBuffer(10);
const buf = Buffer.from(ab, 0, 2);

console.log(buf.length);
// 打印: 2const { Buffer } = require('buffer');

const ab = new ArrayBuffer(10);
const buf = Buffer.from(ab, 0, 2);

console.log(buf.length);
// 打印: 2

如果 arrayBuffer 不是 ArrayBufferSharedArrayBuffer 或其他适用于 Buffer.from() 变体的类型,则将抛出 TypeError

记住,支持 ArrayBuffer 可以覆盖超出 TypedArray 视图边界的内存范围。 使用 TypedArraybuffer 属性创建的新 Buffer 可能会超出 TypedArray 的范围:

import { Buffer } from 'buffer';

const arrA = Uint8Array.from([0x63, 0x64, 0x65, 0x66]); // 4 个元素
const arrB = new Uint8Array(arrA.buffer, 1, 2); // 2 个元素
console.log(arrA.buffer === arrB.buffer); // true

const buf = Buffer.from(arrB.buffer);
console.log(buf);
// 打印: <Buffer 63 64 65 66>const { Buffer } = require('buffer');

const arrA = Uint8Array.from([0x63, 0x64, 0x65, 0x66]); // 4 个元素
const arrB = new Uint8Array(arrA.buffer, 1, 2); // 2 个元素
console.log(arrA.buffer === arrB.buffer); // true

const buf = Buffer.from(arrB.buffer);
console.log(buf);
// 打印: <Buffer 63 64 65 66>

Buffer.from(buffer)#

中英对照

将传入的 buffer 数据复制到新的 Buffer 实例上。

import { Buffer } from 'buffer';

const buf1 = Buffer.from('buffer');
const buf2 = Buffer.from(buf1);

buf1[0] = 0x61;

console.log(buf1.toString());
// 打印: auffer
console.log(buf2.toString());
// 打印: bufferconst { Buffer } = require('buffer');

const buf1 = Buffer.from('buffer');
const buf2 = Buffer.from(buf1);

buf1[0] = 0x61;

console.log(buf1.toString());
// 打印: auffer
console.log(buf2.toString());
// 打印: buffer

如果 buffer 不是 Buffer 或其他适用于 Buffer.from() 变体的类型,则将抛出 TypeError

Buffer.from(object[, offsetOrEncoding[, length]])#

中英对照

对于 valueOf() 函数返回的值不严格等于 object 的对象,则返回 Buffer.from(object.valueOf(), offsetOrEncoding, length)

import { Buffer } from 'buffer';

const buf = Buffer.from(new String('this is a test'));
// 打印: <Buffer 74 68 69 73 20 69 73 20 61 20 74 65 73 74>const { Buffer } = require('buffer');

const buf = Buffer.from(new String('this is a test'));
// 打印: <Buffer 74 68 69 73 20 69 73 20 61 20 74 65 73 74>

对于支持 Symbol.toPrimitive 的对象,则返回 Buffer.from(object[Symbol.toPrimitive]('string'), offsetOrEncoding)

import { Buffer } from 'buffer';

class Foo {
  [Symbol.toPrimitive]() {
    return 'this is a test';
  }
}

const buf = Buffer.from(new Foo(), 'utf8');
// 打印: <Buffer 74 68 69 73 20 69 73 20 61 20 74 65 73 74>const { Buffer } = require('buffer');

class Foo {
  [Symbol.toPrimitive]() {
    return 'this is a test';
  }
}

const buf = Buffer.from(new Foo(), 'utf8');
// 打印: <Buffer 74 68 69 73 20 69 73 20 61 20 74 65 73 74>

如果 object 没有提到的方法或不是适合 Buffer.from() 变体的另一种类型,则将抛出 TypeError

Buffer.from(string[, encoding])#

中英对照

  • string <string> 要编码的字符串。
  • encoding <string> string 的编码。 默认值: 'utf8'

创建包含 string 的新 Bufferencoding 参数标识将 string 转换为字节时要使用的字符编码。

import { Buffer } from 'buffer';

const buf1 = Buffer.from('this is a tést');
const buf2 = Buffer.from('7468697320697320612074c3a97374', 'hex');

console.log(buf1.toString());
// 打印: this is a tést
console.log(buf2.toString());
// 打印: this is a tést
console.log(buf1.toString('latin1'));
// 打印: this is a téstconst { Buffer } = require('buffer');

const buf1 = Buffer.from('this is a tést');
const buf2 = Buffer.from('7468697320697320612074c3a97374', 'hex');

console.log(buf1.toString());
// 打印: this is a tést
console.log(buf2.toString());
// 打印: this is a tést
console.log(buf1.toString('latin1'));
// 打印: this is a tést

如果 string 不是字符串或其他适用于 Buffer.from() 变体的类型,则将抛出 TypeError

Buffer.isBuffer(obj)#

中英对照

如果 objBuffer,则返回 true,否则返回 false

import { Buffer } from 'buffer';

Buffer.isBuffer(Buffer.alloc(10)); // true
Buffer.isBuffer(Buffer.from('foo')); // true
Buffer.isBuffer('a string'); // false
Buffer.isBuffer([]); // false
Buffer.isBuffer(new Uint8Array(1024)); // falseconst { Buffer } = require('buffer');

Buffer.isBuffer(Buffer.alloc(10)); // true
Buffer.isBuffer(Buffer.from('foo')); // true
Buffer.isBuffer('a string'); // false
Buffer.isBuffer([]); // false
Buffer.isBuffer(new Uint8Array(1024)); // false

Buffer.isEncoding(encoding)#

中英对照

如果 encoding 是支持的字符编码的名称,则返回 true,否则返回 false

import { Buffer } from 'buffer';

console.log(Buffer.isEncoding('utf8'));
// 打印: true

console.log(Buffer.isEncoding('hex'));
// 打印: true

console.log(Buffer.isEncoding('utf/8'));
// 打印: false

console.log(Buffer.isEncoding(''));
// 打印: falseconst { Buffer } = require('buffer');

console.log(Buffer.isEncoding('utf8'));
// 打印: true

console.log(Buffer.isEncoding('hex'));
// 打印: true

console.log(Buffer.isEncoding('utf/8'));
// 打印: false

console.log(Buffer.isEncoding(''));
// 打印: false

Buffer.poolSize#

中英对照

这是用于池的预分配内部 Buffer 实例的大小(以字节为单位)。 该值可以修改。

buf[index]#

中英对照

索引运算符 [index] 可用于获取和设置 buf 中位置 index 处的八位字节。 这些值是指单个字节,因此合法值范围介于 0x000xFF(十六进制)或 0255(十进制)之间。

该运算符继承自 Uint8Array,因此其越界访问行为与 Uint8Array 相同。 换句话说,当 index 为负或大于等于 buf.length 时,buf[index] 返回 undefined,如果 index 为负或 >= buf.lengthbuf[index] = value 不修改缓冲区。

import { Buffer } from 'buffer';

// 每次一个字节地将 ASCII 字符串复制到 `Buffer` 中。
// (这仅适用于 ASCII-only 字符串。通常,应该使用 `Buffer.from()` 来执行此转换。)

const str = 'Node.js';
const buf = Buffer.allocUnsafe(str.length);

for (let i = 0; i < str.length; i++) {
  buf[i] = str.charCodeAt(i);
}

console.log(buf.toString('utf8'));
// 打印: Node.jsconst { Buffer } = require('buffer');

// 每次一个字节地将 ASCII 字符串复制到 `Buffer` 中。
// (这仅适用于 ASCII-only 字符串。通常,应该使用 `Buffer.from()` 来执行此转换。)

const str = 'Node.js';
const buf = Buffer.allocUnsafe(str.length);

for (let i = 0; i < str.length; i++) {
  buf[i] = str.charCodeAt(i);
}

console.log(buf.toString('utf8'));
// 打印: Node.js

buf.buffer#

中英对照

  • <ArrayBuffer> 创建此 Buffer 对象所基于的底层 ArrayBuffer 对象。

不保证此 ArrayBuffer 与原始 Buffer 完全对应。 有关详细信息,请参阅 buf.byteOffset 上的说明。

import { Buffer } from 'buffer';

const arrayBuffer = new ArrayBuffer(16);
const buffer = Buffer.from(arrayBuffer);

console.log(buffer.buffer === arrayBuffer);
// 打印: trueconst { Buffer } = require('buffer');

const arrayBuffer = new ArrayBuffer(16);
const buffer = Buffer.from(arrayBuffer);

console.log(buffer.buffer === arrayBuffer);
// 打印: true

buf.byteOffset#

中英对照

  • <integer> Buffer 底层 ArrayBuffer 对象的 byteOffset

当在 Buffer.from(ArrayBuffer, byteOffset, length) 中设置 byteOffset 时,或者有时在分配小于 Buffer.poolSizeBuffer 时,缓冲区不会从底层 ArrayBuffer 上的零偏移量开始。

这在使用 buf.buffer 直接访问底层 ArrayBuffer 时可能会导致问题,因为 ArrayBuffer 的其他部分可能与 Buffer 对象本身无关。

创建与 Buffer 共享内存的 TypedArray 对象时的常见问题是,在这种情况下,需要正确指定 byteOffset

import { Buffer } from 'buffer';

// 创建小于 `Buffer.poolSize` 的缓冲区。
const nodeBuffer = new Buffer.from([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);

// 当将 Node.js 缓冲区转换为 Int8Array 时,
// 使用 byteOffset 仅引用包含 `nodeBuffer` 内存的 `nodeBuffer.buffer` 部分。
new Int8Array(nodeBuffer.buffer, nodeBuffer.byteOffset, nodeBuffer.length);const { Buffer } = require('buffer');

// 创建小于 `Buffer.poolSize` 的缓冲区。
const nodeBuffer = new Buffer.from([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);

// 当将 Node.js 缓冲区转换为 Int8Array 时,
// 使用 byteOffset 仅引用包含 `nodeBuffer` 内存的 `nodeBuffer.buffer` 部分。
new Int8Array(nodeBuffer.buffer, nodeBuffer.byteOffset, nodeBuffer.length);

buf.compare(target[, targetStart[, targetEnd[, sourceStart[, sourceEnd]]]])#

中英对照

  • target <Buffer> | <Uint8Array> 用于比较 bufBufferUint8Array
  • targetStart <integer> target 内开始比较的偏移量。 默认值: 0
  • targetEnd <integer> target 中结束比较(不包括)的偏移量。 默认值: target.length
  • sourceStart <integer> buf 内开始比较的偏移量。 默认值: 0
  • sourceEnd <integer> buf 中结束比较(不包括)的偏移量。 默认值: buf.length.
  • 返回: <integer>

buftarget 进行比较并返回数字,该数字指示 buf 在排序顺序中是在 target 之前、之后还是与 target 相同。 比较基于每个 Buffer 中的实际字节序列。

  • 如果 targetbuf 相同,则返回 0
  • 如果排序时 target 应该在 buf 之前,则返回 1
  • 如果排序时 target 应该在 buf 之后,则返回 -1
import { Buffer } from 'buffer';

const buf1 = Buffer.from('ABC');
const buf2 = Buffer.from('BCD');
const buf3 = Buffer.from('ABCD');

console.log(buf1.compare(buf1));
// 打印: 0
console.log(buf1.compare(buf2));
// 打印: -1
console.log(buf1.compare(buf3));
// 打印: -1
console.log(buf2.compare(buf1));
// 打印: 1
console.log(buf2.compare(buf3));
// 打印: 1
console.log([buf1, buf2, buf3].sort(Buffer.compare));
// 打印: [ <Buffer 41 42 43>, <Buffer 41 42 43 44>, <Buffer 42 43 44> ]
// (此结果相当于:[buf1, buf3, buf2]。)const { Buffer } = require('buffer');

const buf1 = Buffer.from('ABC');
const buf2 = Buffer.from('BCD');
const buf3 = Buffer.from('ABCD');

console.log(buf1.compare(buf1));
// 打印: 0
console.log(buf1.compare(buf2));
// 打印: -1
console.log(buf1.compare(buf3));
// 打印: -1
console.log(buf2.compare(buf1));
// 打印: 1
console.log(buf2.compare(buf3));
// 打印: 1
console.log([buf1, buf2, buf3].sort(Buffer.compare));
// 打印: [ <Buffer 41 42 43>, <Buffer 41 42 43 44>, <Buffer 42 43 44> ]
// (此结果相当于:[buf1, buf3, buf2]。)

可选的 targetStarttargetEndsourceStartsourceEnd 参数可用于分别将比较限制在 targetbuf 内的特定范围内。

import { Buffer } from 'buffer';

const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
const buf2 = Buffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]);

console.log(buf1.compare(buf2, 5, 9, 0, 4));
// 打印: 0
console.log(buf1.compare(buf2, 0, 6, 4));
// 打印: -1
console.log(buf1.compare(buf2, 5, 6, 5));
// 打印: 1const { Buffer } = require('buffer');

const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
const buf2 = Buffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]);

console.log(buf1.compare(buf2, 5, 9, 0, 4));
// 打印: 0
console.log(buf1.compare(buf2, 0, 6, 4));
// 打印: -1
console.log(buf1.compare(buf2, 5, 6, 5));
// 打印: 1

如果 targetStart < 0sourceStart < 0targetEnd > target.byteLengthsourceEnd > source.byteLength,则抛出 ERR_OUT_OF_RANGE

buf.copy(target[, targetStart[, sourceStart[, sourceEnd]]])#

中英对照

将数据从 buf 的区域复制到 target 的区域,即使 target 内存区域与 buf 重叠。

TypedArray.prototype.set() 执行相同的操作,可用于所有 TypedArray,包括 Node.js Buffer,尽管它采用不同的函数参数。

import { Buffer } from 'buffer';

// 创建两个 `Buffer` 实例。
const buf1 = Buffer.allocUnsafe(26);
const buf2 = Buffer.allocUnsafe(26).fill('!');

for (let i = 0; i < 26; i++) {
  // 97 是 'a' 的十进制 ASCII 值。
  buf1[i] = i + 97;
}

// 将 `buf1` 字节 16 到 19 复制到 `buf2` 中,从 `buf2` 的字节 8 开始。
buf1.copy(buf2, 8, 16, 20);
// 这相当于:
// buf2.set(buf1.subarray(16, 20), 8);

console.log(buf2.toString('ascii', 0, 25));
// 打印: !!!!!!!!qrst!!!!!!!!!!!!!const { Buffer } = require('buffer');

// 创建两个 `Buffer` 实例。
const buf1 = Buffer.allocUnsafe(26);
const buf2 = Buffer.allocUnsafe(26).fill('!');

for (let i = 0; i < 26; i++) {
  // 97 是 'a' 的十进制 ASCII 值。
  buf1[i] = i + 97;
}

// 将 `buf1` 字节 16 到 19 复制到 `buf2` 中,从 `buf2` 的字节 8 开始。
buf1.copy(buf2, 8, 16, 20);
// 这相当于:
// buf2.set(buf1.subarray(16, 20), 8);

console.log(buf2.toString('ascii', 0, 25));
// 打印: !!!!!!!!qrst!!!!!!!!!!!!!
import { Buffer } from 'buffer';

// 创建 `Buffer` 并将数据从一个区域复制到同一 `Buffer` 内的重叠区域。

const buf = Buffer.allocUnsafe(26);

for (let i = 0; i < 26; i++) {
  // 97 是 'a' 的十进制 ASCII 值。
  buf[i] = i + 97;
}

buf.copy(buf, 0, 4, 10);

console.log(buf.toString());
// 打印: efghijghijklmnopqrstuvwxyzconst { Buffer } = require('buffer');

// 创建 `Buffer` 并将数据从一个区域复制到同一 `Buffer` 内的重叠区域。

const buf = Buffer.allocUnsafe(26);

for (let i = 0; i < 26; i++) {
  // 97 是 'a' 的十进制 ASCII 值。
  buf[i] = i + 97;
}

buf.copy(buf, 0, 4, 10);

console.log(buf.toString());
// 打印: efghijghijklmnopqrstuvwxyz

buf.entries()#

中英对照

buf 的内容创建并返回 [index, byte] 对的迭代器

import { Buffer } from 'buffer';

// 记录 `Buffer` 的全部内容。

const buf = Buffer.from('buffer');

for (const pair of buf.entries()) {
  console.log(pair);
}
// 打印:
//   [0, 98]
//   [1, 117]
//   [2, 102]
//   [3, 102]
//   [4, 101]
//   [5, 114]const { Buffer } = require('buffer');

// 记录 `Buffer` 的全部内容。

const buf = Buffer.from('buffer');

for (const pair of buf.entries()) {
  console.log(pair);
}
// 打印:
//   [0, 98]
//   [1, 117]
//   [2, 102]
//   [3, 102]
//   [4, 101]
//   [5, 114]

buf.equals(otherBuffer)#

中英对照

如果 bufotherBuffer 具有完全相同的字节,则返回 true,否则返回 false。 相当于 buf.compare(otherBuffer) === 0

import { Buffer } from 'buffer';

const buf1 = Buffer.from('ABC');
const buf2 = Buffer.from('414243', 'hex');
const buf3 = Buffer.from('ABCD');

console.log(buf1.equals(buf2));
// 打印: true
console.log(buf1.equals(buf3));
// 打印: falseconst { Buffer } = require('buffer');

const buf1 = Buffer.from('ABC');
const buf2 = Buffer.from('414243', 'hex');
const buf3 = Buffer.from('ABCD');

console.log(buf1.equals(buf2));
// 打印: true
console.log(buf1.equals(buf3));
// 打印: false

buf.fill(value[, offset[, end]][, encoding])#

中英对照

用指定的 value 填充 buf。 如果没有给定 offsetend,则整个 buf 都会被填满:

import { Buffer } from 'buffer';

// 用 ASCII 字符 'h' 填充 `Buffer`。

const b = Buffer.allocUnsafe(50).fill('h');

console.log(b.toString());
// 打印: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhconst { Buffer } = require('buffer');

// 用 ASCII 字符 'h' 填充 `Buffer`。

const b = Buffer.allocUnsafe(50).fill('h');

console.log(b.toString());
// 打印: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh

如果 value 不是字符串、Buffer 或整数,则将其强制为 uint32 值。 如果结果整数大于 255(十进制),则 buf 将填充 value & 255

如果 fill() 操作的最终写入落在多字节字符上,则仅写入适合 buf 的该字符的字节:

import { Buffer } from 'buffer';

// 用在 UTF-8 中占用两个字节的字符填充 `Buffer`。

console.log(Buffer.allocUnsafe(5).fill('\u0222'));
// 打印: <Buffer c8 a2 c8 a2 c8>const { Buffer } = require('buffer');

// 用在 UTF-8 中占用两个字节的字符填充 `Buffer`。

console.log(Buffer.allocUnsafe(5).fill('\u0222'));
// 打印: <Buffer c8 a2 c8 a2 c8>

如果 value 包含无效字符,则截断;如果没有有效的填充数据,则抛出异常:

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(5);

console.log(buf.fill('a'));
// 打印: <Buffer 61 61 61 61 61>
console.log(buf.fill('aazz', 'hex'));
// 打印: <Buffer aa aa aa aa aa>
console.log(buf.fill('zz', 'hex'));
// 抛出异常。const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(5);

console.log(buf.fill('a'));
// 打印: <Buffer 61 61 61 61 61>
console.log(buf.fill('aazz', 'hex'));
// 打印: <Buffer aa aa aa aa aa>
console.log(buf.fill('zz', 'hex'));
// 抛出异常。

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

中英对照

  • value <string> | <Buffer> | <Uint8Array> | <integer> 要搜索的内容。
  • byteOffset <integer> 开始搜索 buf 的位置。 如果为负数,则从 buf 的末尾开始计算偏移量。 默认值: 0
  • encoding <string> 如果 value 是字符串,则这就是它的编码。 默认值: 'utf8'
  • 返回: <boolean> 如果在 buf 中找到 value,则为 true,否则为 false

相当于 buf.indexOf() !== -1

import { Buffer } from 'buffer';

const buf = Buffer.from('this is a buffer');

console.log(buf.includes('this'));
// 打印: true
console.log(buf.includes('is'));
// 打印: true
console.log(buf.includes(Buffer.from('a buffer')));
// 打印: true
console.log(buf.includes(97));
// 打印: true (97 是 'a' 的十进制 ASCII 值)
console.log(buf.includes(Buffer.from('a buffer example')));
// 打印: false
console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
// 打印: true
console.log(buf.includes('this', 4));
// 打印: falseconst { Buffer } = require('buffer');

const buf = Buffer.from('this is a buffer');

console.log(buf.includes('this'));
// 打印: true
console.log(buf.includes('is'));
// 打印: true
console.log(buf.includes(Buffer.from('a buffer')));
// 打印: true
console.log(buf.includes(97));
// 打印: true (97 是 'a' 的十进制 ASCII 值)
console.log(buf.includes(Buffer.from('a buffer example')));
// 打印: false
console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
// 打印: true
console.log(buf.includes('this', 4));
// 打印: false

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

中英对照

  • value <string> | <Buffer> | <Uint8Array> | <integer> 要搜索的内容。
  • byteOffset <integer> 开始搜索 buf 的位置。 如果为负数,则从 buf 的末尾开始计算偏移量。 默认值: 0
  • encoding <string> 如果 value 是字符串,则这是用于确定将在 buf 中搜索的字符串的二进制表示的编码。 默认值: 'utf8'
  • 返回: <integer> buf 中第一次出现 value 的索引,如果 buf 不包含 value,则为 -1

如果 value 是:

  • 字符串,value 根据 encoding 中的字符编码进行解释。
  • BufferUint8Array, value 将全部使用。 要比较部分 Buffer,则使用 buf.slice()
  • 数字,value 将被解释为 0255 之间的无符号 8 位整数值。
import { Buffer } from 'buffer';

const buf = Buffer.from('this is a buffer');

console.log(buf.indexOf('this'));
// 打印: 0
console.log(buf.indexOf('is'));
// 打印: 2
console.log(buf.indexOf(Buffer.from('a buffer')));
// 打印: 8
console.log(buf.indexOf(97));
// 打印: 8 (97 是 'a' 的十进制 ASCII 值)
console.log(buf.indexOf(Buffer.from('a buffer example')));
// 打印: -1
console.log(buf.indexOf(Buffer.from('a buffer example').slice(0, 8)));
// 打印: 8

const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

console.log(utf16Buffer.indexOf('\u03a3', 0, 'utf16le'));
// 打印: 4
console.log(utf16Buffer.indexOf('\u03a3', -4, 'utf16le'));
// 打印: 6const { Buffer } = require('buffer');

const buf = Buffer.from('this is a buffer');

console.log(buf.indexOf('this'));
// 打印: 0
console.log(buf.indexOf('is'));
// 打印: 2
console.log(buf.indexOf(Buffer.from('a buffer')));
// 打印: 8
console.log(buf.indexOf(97));
// 打印: 8 (97 是 'a' 的十进制 ASCII 值)
console.log(buf.indexOf(Buffer.from('a buffer example')));
// 打印: -1
console.log(buf.indexOf(Buffer.from('a buffer example').slice(0, 8)));
// 打印: 8

const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

console.log(utf16Buffer.indexOf('\u03a3', 0, 'utf16le'));
// 打印: 4
console.log(utf16Buffer.indexOf('\u03a3', -4, 'utf16le'));
// 打印: 6

如果 value 不是字符串、数字或 Buffer,则此方法将抛出 TypeError。 如果 value 是数字,则它将被强制转换为有效的字节值(0 到 255 之间的整数)。

如果 byteOffset 不是数字,则会被强制为数字。 如果强制转换的结果是 NaN0,则将搜索整个缓冲区。 此行为与 String.prototype.indexOf() 匹配。

import { Buffer } from 'buffer';

const b = Buffer.from('abcdef');

// 传入数字值,但不是有效字节。
// 打印: 2, 相当于搜索 99 或 'c'。
console.log(b.indexOf(99.9));
console.log(b.indexOf(256 + 99));

// 传入强制为 NaN 或 0 的 byteOffset。
// 打印: 1, 搜索整个缓冲区。
console.log(b.indexOf('b', undefined));
console.log(b.indexOf('b', {}));
console.log(b.indexOf('b', null));
console.log(b.indexOf('b', []));const { Buffer } = require('buffer');

const b = Buffer.from('abcdef');

// 传入数字值,但不是有效字节。
// 打印: 2, 相当于搜索 99 或 'c'。
console.log(b.indexOf(99.9));
console.log(b.indexOf(256 + 99));

// 传入强制为 NaN 或 0 的 byteOffset。
// 打印: 1, 搜索整个缓冲区。
console.log(b.indexOf('b', undefined));
console.log(b.indexOf('b', {}));
console.log(b.indexOf('b', null));
console.log(b.indexOf('b', []));

如果 value 为空字符串或空 BufferbyteOffset 小于 buf.length,则返回 byteOffset。 如果 value 为空且 byteOffset 至少为 buf.length,则返回 buf.length

buf.keys()#

中英对照

创建并返回 buf 个键(索引)的迭代器

import { Buffer } from 'buffer';

const buf = Buffer.from('buffer');

for (const key of buf.keys()) {
  console.log(key);
}
// 打印:
//   0
//   1
//   2
//   3
//   4
//   5const { Buffer } = require('buffer');

const buf = Buffer.from('buffer');

for (const key of buf.keys()) {
  console.log(key);
}
// 打印:
//   0
//   1
//   2
//   3
//   4
//   5

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

中英对照

  • value <string> | <Buffer> | <Uint8Array> | <integer> 要搜索的内容。
  • byteOffset <integer> 开始搜索 buf 的位置。 如果为负数,则从 buf 的末尾开始计算偏移量。 默认值: buf.length - 1
  • encoding <string> 如果 value 是字符串,则这是用于确定将在 buf 中搜索的字符串的二进制表示的编码。 默认值: 'utf8'
  • 返回: <integer> buf 中最后一次出现 value 的索引,如果 buf 不包含 value,则为 -1

buf.indexOf() 相同,除了找到最后一次出现的 value 而不是第一次出现。

import { Buffer } from 'buffer';

const buf = Buffer.from('this buffer is a buffer');

console.log(buf.lastIndexOf('this'));
// 打印: 0
console.log(buf.lastIndexOf('buffer'));
// 打印: 17
console.log(buf.lastIndexOf(Buffer.from('buffer')));
// 打印: 17
console.log(buf.lastIndexOf(97));
// 打印: 15 (97 是 'a' 的十进制 ASCII 值)
console.log(buf.lastIndexOf(Buffer.from('yolo')));
// 打印: -1
console.log(buf.lastIndexOf('buffer', 5));
// 打印: 5
console.log(buf.lastIndexOf('buffer', 4));
// 打印: -1

const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
// 打印: 6
console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
// 打印: 4const { Buffer } = require('buffer');

const buf = Buffer.from('this buffer is a buffer');

console.log(buf.lastIndexOf('this'));
// 打印: 0
console.log(buf.lastIndexOf('buffer'));
// 打印: 17
console.log(buf.lastIndexOf(Buffer.from('buffer')));
// 打印: 17
console.log(buf.lastIndexOf(97));
// 打印: 15 (97 是 'a' 的十进制 ASCII 值)
console.log(buf.lastIndexOf(Buffer.from('yolo')));
// 打印: -1
console.log(buf.lastIndexOf('buffer', 5));
// 打印: 5
console.log(buf.lastIndexOf('buffer', 4));
// 打印: -1

const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
// 打印: 6
console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
// 打印: 4

如果 value 不是字符串、数字或 Buffer,则此方法将抛出 TypeError。 如果 value 是数字,则它将被强制转换为有效的字节值(0 到 255 之间的整数)。

如果 byteOffset 不是数字,则会被强制为数字。 任何强制到 NaN 的参数,如 {}undefined,都将搜索整个缓冲区。 此行为与 String.prototype.lastIndexOf() 匹配。

import { Buffer } from 'buffer';

const b = Buffer.from('abcdef');

// 传入数字值,但不是有效字节。
// 打印: 2, 相当于搜索 99 或 'c'。
console.log(b.lastIndexOf(99.9));
console.log(b.lastIndexOf(256 + 99));

// 传入强制为 NaN 的 byteOffset。
// 打印: 1, 搜索整个缓冲区。
console.log(b.lastIndexOf('b', undefined));
console.log(b.lastIndexOf('b', {}));

// 传递强制为 0 的 byteOffset。
// 打印: -1, 相当于传入 0。
console.log(b.lastIndexOf('b', null));
console.log(b.lastIndexOf('b', []));const { Buffer } = require('buffer');

const b = Buffer.from('abcdef');

// 传入数字值,但不是有效字节。
// 打印: 2, 相当于搜索 99 或 'c'。
console.log(b.lastIndexOf(99.9));
console.log(b.lastIndexOf(256 + 99));

// 传入强制为 NaN 的 byteOffset。
// 打印: 1, 搜索整个缓冲区。
console.log(b.lastIndexOf('b', undefined));
console.log(b.lastIndexOf('b', {}));

// 传递强制为 0 的 byteOffset。
// 打印: -1, 相当于传入 0。
console.log(b.lastIndexOf('b', null));
console.log(b.lastIndexOf('b', []));

如果 value 为空字符串或空 Buffer,则返回 byteOffset

buf.length#

中英对照

返回 buf 中的字节数。

import { Buffer } from 'buffer';

// 创建 `Buffer` 并使用 UTF-8 向其写入一个较短的字符串。

const buf = Buffer.alloc(1234);

console.log(buf.length);
// 打印: 1234

buf.write('some string', 0, 'utf8');

console.log(buf.length);
// 打印: 1234const { Buffer } = require('buffer');

// 创建 `Buffer` 并使用 UTF-8 向其写入一个较短的字符串。

const buf = Buffer.alloc(1234);

console.log(buf.length);
// 打印: 1234

buf.write('some string', 0, 'utf8');

console.log(buf.length);
// 打印: 1234

buf.parent#

中英对照

稳定性: 0 - 弃用: 改为使用 buf.buffer

buf.parent 属性是 buf.buffer 的弃用别名。

buf.readBigInt64BE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足:0 <= offset <= buf.length - 8默认值: 0
  • 返回: <bigint>

从指定的 offset 处的 buf 读取有符号的大端序 64 位整数。

Buffer 读取的整数被解释为二进制补码有符号值。

buf.readBigInt64LE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足:0 <= offset <= buf.length - 8默认值: 0
  • 返回: <bigint>

从指定的 offset 处的 buf 读取有符号的小端序 64 位整数。

Buffer 读取的整数被解释为二进制补码有符号值。

buf.readBigUInt64BE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足:0 <= offset <= buf.length - 8默认值: 0
  • 返回: <bigint>

从指定的 offset 处的 buf 读取无符号的大端序 64 位整数。

此函数也可在 readBigUint64BE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

console.log(buf.readBigUInt64BE(0));
// 打印: 4294967295nconst { Buffer } = require('buffer');

const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

console.log(buf.readBigUInt64BE(0));
// 打印: 4294967295n

buf.readBigUInt64LE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足:0 <= offset <= buf.length - 8默认值: 0
  • 返回: <bigint>

从指定的 offset 处的 buf 读取无符号的小端序 64 位整数。

此函数也可在 readBigUint64LE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

console.log(buf.readBigUInt64LE(0));
// 打印: 18446744069414584320nconst { Buffer } = require('buffer');

const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

console.log(buf.readBigUInt64LE(0));
// 打印: 18446744069414584320n

buf.readDoubleBE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 8默认值: 0
  • 返回: <number>

从指定 offset 处的 buf 读取 64 位大端序双精度值。

import { Buffer } from 'buffer';

const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

console.log(buf.readDoubleBE(0));
// 打印: 8.20788039913184e-304const { Buffer } = require('buffer');

const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

console.log(buf.readDoubleBE(0));
// 打印: 8.20788039913184e-304

buf.readDoubleLE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 8默认值: 0
  • 返回: <number>

从指定 offset 处的 buf 读取 64 位小端序双精度值。

import { Buffer } from 'buffer';

const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

console.log(buf.readDoubleLE(0));
// 打印: 5.447603722011605e-270
console.log(buf.readDoubleLE(1));
// 抛出 ERR_OUT_OF_RANGE。const { Buffer } = require('buffer');

const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

console.log(buf.readDoubleLE(0));
// 打印: 5.447603722011605e-270
console.log(buf.readDoubleLE(1));
// 抛出 ERR_OUT_OF_RANGE。

buf.readFloatBE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 4默认值: 0
  • 返回: <number>

从指定 offset 处的 buf 读取 32 位大端序浮点数。

import { Buffer } from 'buffer';

const buf = Buffer.from([1, 2, 3, 4]);

console.log(buf.readFloatBE(0));
// 打印: 2.387939260590663e-38const { Buffer } = require('buffer');

const buf = Buffer.from([1, 2, 3, 4]);

console.log(buf.readFloatBE(0));
// 打印: 2.387939260590663e-38

buf.readFloatLE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 4默认值: 0
  • 返回: <number>

从指定 offset 处的 buf 读取 32 位小端序浮点数。

import { Buffer } from 'buffer';

const buf = Buffer.from([1, 2, 3, 4]);

console.log(buf.readFloatLE(0));
// 打印: 1.539989614439558e-36
console.log(buf.readFloatLE(1));
// 抛出 ERR_OUT_OF_RANGE。const { Buffer } = require('buffer');

const buf = Buffer.from([1, 2, 3, 4]);

console.log(buf.readFloatLE(0));
// 打印: 1.539989614439558e-36
console.log(buf.readFloatLE(1));
// 抛出 ERR_OUT_OF_RANGE。

buf.readInt8([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 1默认值: 0
  • 返回: <integer>

从指定的 offset 处的 buf 读取有符号的 8 位整数。

Buffer 读取的整数被解释为二进制补码有符号值。

import { Buffer } from 'buffer';

const buf = Buffer.from([-1, 5]);

console.log(buf.readInt8(0));
// 打印: -1
console.log(buf.readInt8(1));
// 打印: 5
console.log(buf.readInt8(2));
// 抛出 ERR_OUT_OF_RANGE。const { Buffer } = require('buffer');

const buf = Buffer.from([-1, 5]);

console.log(buf.readInt8(0));
// 打印: -1
console.log(buf.readInt8(1));
// 打印: 5
console.log(buf.readInt8(2));
// 抛出 ERR_OUT_OF_RANGE。

buf.readInt16BE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 2默认值: 0
  • 返回: <integer>

从指定的 offset 处的 buf 读取有符号的大端序 16 位整数。

Buffer 读取的整数被解释为二进制补码有符号值。

import { Buffer } from 'buffer';

const buf = Buffer.from([0, 5]);

console.log(buf.readInt16BE(0));
// 打印: 5const { Buffer } = require('buffer');

const buf = Buffer.from([0, 5]);

console.log(buf.readInt16BE(0));
// 打印: 5

buf.readInt16LE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 2默认值: 0
  • 返回: <integer>

从指定的 offset 处的 buf 读取有符号的小端序 16 位整数。

Buffer 读取的整数被解释为二进制补码有符号值。

import { Buffer } from 'buffer';

const buf = Buffer.from([0, 5]);

console.log(buf.readInt16LE(0));
// 打印: 1280
console.log(buf.readInt16LE(1));
// 抛出 ERR_OUT_OF_RANGE。const { Buffer } = require('buffer');

const buf = Buffer.from([0, 5]);

console.log(buf.readInt16LE(0));
// 打印: 1280
console.log(buf.readInt16LE(1));
// 抛出 ERR_OUT_OF_RANGE。

buf.readInt32BE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 4默认值: 0
  • 返回: <integer>

从指定的 offset 处的 buf 读取有符号的大端序 32 位整数。

Buffer 读取的整数被解释为二进制补码有符号值。

import { Buffer } from 'buffer';

const buf = Buffer.from([0, 0, 0, 5]);

console.log(buf.readInt32BE(0));
// 打印: 5const { Buffer } = require('buffer');

const buf = Buffer.from([0, 0, 0, 5]);

console.log(buf.readInt32BE(0));
// 打印: 5

buf.readInt32LE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 4默认值: 0
  • 返回: <integer>

从指定的 offset 处的 buf 读取有符号的小端序 32 位整数。

Buffer 读取的整数被解释为二进制补码有符号值。

import { Buffer } from 'buffer';

const buf = Buffer.from([0, 0, 0, 5]);

console.log(buf.readInt32LE(0));
// 打印: 83886080
console.log(buf.readInt32LE(1));
// 抛出 ERR_OUT_OF_RANGE。const { Buffer } = require('buffer');

const buf = Buffer.from([0, 0, 0, 5]);

console.log(buf.readInt32LE(0));
// 打印: 83886080
console.log(buf.readInt32LE(1));
// 抛出 ERR_OUT_OF_RANGE。

buf.readIntBE(offset, byteLength)#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - byteLength
  • byteLength <integer> 要读取的字节数。 必须满足 0 < byteLength <= 6
  • 返回: <integer>

从指定的 offset 处的 buf 读取 byteLength 个字节,并将结果解释为支持最高 48 位精度的大端序、二进制补码有符号值。

import { Buffer } from 'buffer';

const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

console.log(buf.readIntBE(0, 6).toString(16));
// 打印: 1234567890ab
console.log(buf.readIntBE(1, 6).toString(16));
// 抛出 ERR_OUT_OF_RANGE。
console.log(buf.readIntBE(1, 0).toString(16));
// 抛出 ERR_OUT_OF_RANGE。const { Buffer } = require('buffer');

const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

console.log(buf.readIntBE(0, 6).toString(16));
// 打印: 1234567890ab
console.log(buf.readIntBE(1, 6).toString(16));
// 抛出 ERR_OUT_OF_RANGE。
console.log(buf.readIntBE(1, 0).toString(16));
// 抛出 ERR_OUT_OF_RANGE。

buf.readIntLE(offset, byteLength)#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - byteLength
  • byteLength <integer> 要读取的字节数。 必须满足 0 < byteLength <= 6
  • 返回: <integer>

从指定的 offset 处的 buf 读取 byteLength 个字节,并将结果解释为支持最高 48 位精度的小端序、二进制补码有符号值。

import { Buffer } from 'buffer';

const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

console.log(buf.readIntLE(0, 6).toString(16));
// 打印: -546f87a9cbeeconst { Buffer } = require('buffer');

const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

console.log(buf.readIntLE(0, 6).toString(16));
// 打印: -546f87a9cbee

buf.readUInt8([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 1默认值: 0
  • 返回: <integer>

从指定 offset 处的 buf 读取无符号 8 位整数。

此函数也可在 readUint8 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.from([1, -2]);

console.log(buf.readUInt8(0));
// 打印: 1
console.log(buf.readUInt8(1));
// 打印: 254
console.log(buf.readUInt8(2));
// 抛出 ERR_OUT_OF_RANGE。const { Buffer } = require('buffer');

const buf = Buffer.from([1, -2]);

console.log(buf.readUInt8(0));
// 打印: 1
console.log(buf.readUInt8(1));
// 打印: 254
console.log(buf.readUInt8(2));
// 抛出 ERR_OUT_OF_RANGE。

buf.readUInt16BE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 2默认值: 0
  • 返回: <integer>

从指定的 offset 处的 buf 读取无符号的大端序 16 位整数。

此函数也可在 readUint16BE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.from([0x12, 0x34, 0x56]);

console.log(buf.readUInt16BE(0).toString(16));
// 打印: 1234
console.log(buf.readUInt16BE(1).toString(16));
// 打印: 3456const { Buffer } = require('buffer');

const buf = Buffer.from([0x12, 0x34, 0x56]);

console.log(buf.readUInt16BE(0).toString(16));
// 打印: 1234
console.log(buf.readUInt16BE(1).toString(16));
// 打印: 3456

buf.readUInt16LE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 2默认值: 0
  • 返回: <integer>

从指定的 offset 处的 buf 读取无符号的小端序 16 位整数。

此函数也可在 readUint16LE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.from([0x12, 0x34, 0x56]);

console.log(buf.readUInt16LE(0).toString(16));
// 打印: 3412
console.log(buf.readUInt16LE(1).toString(16));
// 打印: 5634
console.log(buf.readUInt16LE(2).toString(16));
// 抛出 ERR_OUT_OF_RANGE。const { Buffer } = require('buffer');

const buf = Buffer.from([0x12, 0x34, 0x56]);

console.log(buf.readUInt16LE(0).toString(16));
// 打印: 3412
console.log(buf.readUInt16LE(1).toString(16));
// 打印: 5634
console.log(buf.readUInt16LE(2).toString(16));
// 抛出 ERR_OUT_OF_RANGE。

buf.readUInt32BE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 4默认值: 0
  • 返回: <integer>

从指定的 offset 处的 buf 读取无符号的大端序 32 位整数。

此函数也可在 readUint32BE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

console.log(buf.readUInt32BE(0).toString(16));
// 打印: 12345678const { Buffer } = require('buffer');

const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

console.log(buf.readUInt32BE(0).toString(16));
// 打印: 12345678

buf.readUInt32LE([offset])#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 4默认值: 0
  • 返回: <integer>

从指定的 offset 处的 buf 读取无符号的小端序 32 位整数。

此函数也可在 readUint32LE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

console.log(buf.readUInt32LE(0).toString(16));
// 打印: 78563412
console.log(buf.readUInt32LE(1).toString(16));
// 抛出 ERR_OUT_OF_RANGE。const { Buffer } = require('buffer');

const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

console.log(buf.readUInt32LE(0).toString(16));
// 打印: 78563412
console.log(buf.readUInt32LE(1).toString(16));
// 抛出 ERR_OUT_OF_RANGE。

buf.readUIntBE(offset, byteLength)#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - byteLength
  • byteLength <integer> 要读取的字节数。 必须满足 0 < byteLength <= 6
  • 返回: <integer>

从指定的 offset 处的 buf 读取 byteLength 个字节,并将结果解释为支持最高 48 位精度的无符号大端序整数。

此函数也可在 readUintBE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

console.log(buf.readUIntBE(0, 6).toString(16));
// 打印: 1234567890ab
console.log(buf.readUIntBE(1, 6).toString(16));
// 抛出 ERR_OUT_OF_RANGE。const { Buffer } = require('buffer');

const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

console.log(buf.readUIntBE(0, 6).toString(16));
// 打印: 1234567890ab
console.log(buf.readUIntBE(1, 6).toString(16));
// 抛出 ERR_OUT_OF_RANGE。

buf.readUIntLE(offset, byteLength)#

中英对照

  • offset <integer> 开始读取之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - byteLength
  • byteLength <integer> 要读取的字节数。 必须满足 0 < byteLength <= 6
  • 返回: <integer>

从指定的 offset 处的 buf 读取 byteLength 个字节,并将结果解释为支持最高 48 位精度的无符号小端序整数。

此函数也可在 readUintLE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

console.log(buf.readUIntLE(0, 6).toString(16));
// 打印: ab9078563412const { Buffer } = require('buffer');

const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

console.log(buf.readUIntLE(0, 6).toString(16));
// 打印: ab9078563412

buf.subarray([start[, end]])#

中英对照

  • start <integer> 新的 Buffer 将开始的位置。 默认值: 0
  • end <integer> 新的 Buffer 将结束的位置(不包括在内)。 默认值: buf.length.
  • 返回: <Buffer>

返回新的 Buffer,其引用与原始缓冲区相同的内存,但由 startend 索引进行偏移和裁剪。

指定 end 大于 buf.length 将返回与 end 等于 buf.length 相同的结果。

该方法继承自 TypedArray.prototype.subarray()

修改新的 Buffer 切片会修改原来 Buffer 中的内存,因为两个对象分配的内存是重叠的。

import { Buffer } from 'buffer';

// 用 ASCII 字母创建 `Buffer`,取一个切片,并从原来的 `Buffer` 修改一个字节。

const buf1 = Buffer.allocUnsafe(26);

for (let i = 0; i < 26; i++) {
  // 97 是 'a' 的十进制 ASCII 值。
  buf1[i] = i + 97;
}

const buf2 = buf1.subarray(0, 3);

console.log(buf2.toString('ascii', 0, buf2.length));
// 打印: abc

buf1[0] = 33;

console.log(buf2.toString('ascii', 0, buf2.length));
// 打印: !bcconst { Buffer } = require('buffer');

// 用 ASCII 字母创建 `Buffer`,取一个切片,并从原来的 `Buffer` 修改一个字节。

const buf1 = Buffer.allocUnsafe(26);

for (let i = 0; i < 26; i++) {
  // 97 是 'a' 的十进制 ASCII 值。
  buf1[i] = i + 97;
}

const buf2 = buf1.subarray(0, 3);

console.log(buf2.toString('ascii', 0, buf2.length));
// 打印: abc

buf1[0] = 33;

console.log(buf2.toString('ascii', 0, buf2.length));
// 打印: !bc

指定负索引会导致相对于 buf 的末尾而不是开头生成切片。

import { Buffer } from 'buffer';

const buf = Buffer.from('buffer');

console.log(buf.subarray(-6, -1).toString());
// 打印: buffe
// (相当于 buf.subarray(0, 5).)

console.log(buf.subarray(-6, -2).toString());
// 打印: buff
// (相当于 buf.subarray(0, 4).)

console.log(buf.subarray(-5, -2).toString());
// 打印: uff
// (相当于 buf.subarray(1, 4).)const { Buffer } = require('buffer');

const buf = Buffer.from('buffer');

console.log(buf.subarray(-6, -1).toString());
// 打印: buffe
// (相当于 buf.subarray(0, 5).)

console.log(buf.subarray(-6, -2).toString());
// 打印: buff
// (相当于 buf.subarray(0, 4).)

console.log(buf.subarray(-5, -2).toString());
// 打印: uff
// (相当于 buf.subarray(1, 4).)

buf.slice([start[, end]])#

中英对照

  • start <integer> 新的 Buffer 将开始的位置。 默认值: 0
  • end <integer> 新的 Buffer 将结束的位置(不包括在内)。 默认值: buf.length.
  • 返回: <Buffer>

返回新的 Buffer,其引用与原始缓冲区相同的内存,但由 startend 索引进行偏移和裁剪。

这与 buf.subarray() 的行为相同。

此方法与 Uint8Array.prototype.slice()Buffer 的超类)不兼容。 要复制切片,则使用 Uint8Array.prototype.slice()

import { Buffer } from 'buffer';

const buf = Buffer.from('buffer');

const copiedBuf = Uint8Array.prototype.slice.call(buf);
copiedBuf[0]++;
console.log(copiedBuf.toString());
// 打印: cuffer

console.log(buf.toString());
// 打印: bufferconst { Buffer } = require('buffer');

const buf = Buffer.from('buffer');

const copiedBuf = Uint8Array.prototype.slice.call(buf);
copiedBuf[0]++;
console.log(copiedBuf.toString());
// 打印: cuffer

console.log(buf.toString());
// 打印: buffer

buf.swap16()#

中英对照

buf 解释为无符号 16 位整数数组,并就地交换字节顺序。 如果 buf.length 不是 2 的倍数,则抛出 ERR_INVALID_BUFFER_SIZE

import { Buffer } from 'buffer';

const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

console.log(buf1);
// 打印: <Buffer 01 02 03 04 05 06 07 08>

buf1.swap16();

console.log(buf1);
// 打印: <Buffer 02 01 04 03 06 05 08 07>

const buf2 = Buffer.from([0x1, 0x2, 0x3]);

buf2.swap16();
// 抛出 ERR_INVALID_BUFFER_SIZE。const { Buffer } = require('buffer');

const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

console.log(buf1);
// 打印: <Buffer 01 02 03 04 05 06 07 08>

buf1.swap16();

console.log(buf1);
// 打印: <Buffer 02 01 04 03 06 05 08 07>

const buf2 = Buffer.from([0x1, 0x2, 0x3]);

buf2.swap16();
// 抛出 ERR_INVALID_BUFFER_SIZE。

buf.swap16() 的一种方便用法是在 UTF-16 小端序和 UTF-16 大端序之间执行快速就地转换:

import { Buffer } from 'buffer';

const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
buf.swap16(); // 转换为大端序 UTF-16 文本。const { Buffer } = require('buffer');

const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
buf.swap16(); // 转换为大端序 UTF-16 文本。

buf.swap32()#

中英对照

buf 解释为无符号 32 位整数数组,并就地交换字节顺序。 如果 buf.length 不是 4 的倍数,则抛出 ERR_INVALID_BUFFER_SIZE

import { Buffer } from 'buffer';

const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

console.log(buf1);
// 打印: <Buffer 01 02 03 04 05 06 07 08>

buf1.swap32();

console.log(buf1);
// 打印: <Buffer 04 03 02 01 08 07 06 05>

const buf2 = Buffer.from([0x1, 0x2, 0x3]);

buf2.swap32();
// 抛出 ERR_INVALID_BUFFER_SIZE。const { Buffer } = require('buffer');

const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

console.log(buf1);
// 打印: <Buffer 01 02 03 04 05 06 07 08>

buf1.swap32();

console.log(buf1);
// 打印: <Buffer 04 03 02 01 08 07 06 05>

const buf2 = Buffer.from([0x1, 0x2, 0x3]);

buf2.swap32();
// 抛出 ERR_INVALID_BUFFER_SIZE。

buf.swap64()#

中英对照

buf 解释为 64 位数字数组,并就地交换字节顺序。 如果 buf.length 不是 8 的倍数,则抛出 ERR_INVALID_BUFFER_SIZE

import { Buffer } from 'buffer';

const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

console.log(buf1);
// 打印: <Buffer 01 02 03 04 05 06 07 08>

buf1.swap64();

console.log(buf1);
// 打印: <Buffer 08 07 06 05 04 03 02 01>

const buf2 = Buffer.from([0x1, 0x2, 0x3]);

buf2.swap64();
// 抛出 ERR_INVALID_BUFFER_SIZE。const { Buffer } = require('buffer');

const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

console.log(buf1);
// 打印: <Buffer 01 02 03 04 05 06 07 08>

buf1.swap64();

console.log(buf1);
// 打印: <Buffer 08 07 06 05 04 03 02 01>

const buf2 = Buffer.from([0x1, 0x2, 0x3]);

buf2.swap64();
// 抛出 ERR_INVALID_BUFFER_SIZE。

buf.toJSON()#

中英对照

返回 buf 的 JSON 表示。 JSON.stringify() 在字符串化 Buffer 实例时隐式调用此函数。

Buffer.from() 接受从此方法返回的格式的对象。 特别是,Buffer.from(buf.toJSON()) 的工作方式类似于 Buffer.from(buf)

import { Buffer } from 'buffer';

const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
const json = JSON.stringify(buf);

console.log(json);
// 打印: {"type":"Buffer","data":[1,2,3,4,5]}

const copy = JSON.parse(json, (key, value) => {
  return value && value.type === 'Buffer' ?
    Buffer.from(value) :
    value;
});

console.log(copy);
// 打印: <Buffer 01 02 03 04 05>const { Buffer } = require('buffer');

const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
const json = JSON.stringify(buf);

console.log(json);
// 打印: {"type":"Buffer","data":[1,2,3,4,5]}

const copy = JSON.parse(json, (key, value) => {
  return value && value.type === 'Buffer' ?
    Buffer.from(value) :
    value;
});

console.log(copy);
// 打印: <Buffer 01 02 03 04 05>

buf.toString([encoding[, start[, end]]])#

中英对照

  • encoding <string> 要使用的字符编码。 默认值: 'utf8'
  • start <integer> 开始解码的字节偏移量。 默认值: 0
  • end <integer> 停止解码的字节偏移量(不包括在内)。 默认值: buf.length.
  • 返回: <string>

根据 encoding 中指定的字符编码将 buf 解码为字符串。 startend 可以传入仅解码 buf 的子集。

如果 encoding'utf8' 并且输入中的字节序列不是有效的 UTF-8,则每个无效字节都将替换为替换字符 U+FFFD

字符串实例(以 UTF-16 代码单元表示)的最大长度可用作 buffer.constants.MAX_STRING_LENGTH

import { Buffer } from 'buffer';

const buf1 = Buffer.allocUnsafe(26);

for (let i = 0; i < 26; i++) {
  // 97 是 'a' 的十进制 ASCII 值。
  buf1[i] = i + 97;
}

console.log(buf1.toString('utf8'));
// 打印: abcdefghijklmnopqrstuvwxyz
console.log(buf1.toString('utf8', 0, 5));
// 打印: abcde

const buf2 = Buffer.from('tést');

console.log(buf2.toString('hex'));
// 打印: 74c3a97374
console.log(buf2.toString('utf8', 0, 3));
// 打印: té
console.log(buf2.toString(undefined, 0, 3));
// 打印: téconst { Buffer } = require('buffer');

const buf1 = Buffer.allocUnsafe(26);

for (let i = 0; i < 26; i++) {
  // 97 是 'a' 的十进制 ASCII 值。
  buf1[i] = i + 97;
}

console.log(buf1.toString('utf8'));
// 打印: abcdefghijklmnopqrstuvwxyz
console.log(buf1.toString('utf8', 0, 5));
// 打印: abcde

const buf2 = Buffer.from('tést');

console.log(buf2.toString('hex'));
// 打印: 74c3a97374
console.log(buf2.toString('utf8', 0, 3));
// 打印: té
console.log(buf2.toString(undefined, 0, 3));
// 打印: té

buf.values()#

中英对照

buf 值(字节)创建并返回迭代器。 当在 for..of 语句中使用 Buffer 时,会自动调用此函数。

import { Buffer } from 'buffer';

const buf = Buffer.from('buffer');

for (const value of buf.values()) {
  console.log(value);
}
// 打印:
//   98
//   117
//   102
//   102
//   101
//   114

for (const value of buf) {
  console.log(value);
}
// 打印:
//   98
//   117
//   102
//   102
//   101
//   114const { Buffer } = require('buffer');

const buf = Buffer.from('buffer');

for (const value of buf.values()) {
  console.log(value);
}
// 打印:
//   98
//   117
//   102
//   102
//   101
//   114

for (const value of buf) {
  console.log(value);
}
// 打印:
//   98
//   117
//   102
//   102
//   101
//   114

buf.write(string[, offset[, length]][, encoding])#

中英对照

  • string <string> 要写入 buf 的字符串。
  • offset <integer> 开始写入 string 之前要跳过的字节数。 默认值: 0
  • length <integer> 要写入的最大字节数(写入的字节数不会超过 buf.length - offset)。 默认值: buf.length - offset
  • encoding <string> string 的字符编码。 默认值: 'utf8'
  • 返回: <integer> 写入的字节数。

根据 encoding 中的字符编码将 string 写入 bufoffset 处。 length 参数是要写入的字节数。 如果 buf 没有足够的空间来容纳整个字符串,则只会写入 string 的一部分。 但是,不会写入部分编码的字符。

import { Buffer } from 'buffer';

const buf = Buffer.alloc(256);

const len = buf.write('\u00bd + \u00bc = \u00be', 0);

console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
// 打印: 12 bytes: ½ + ¼ = ¾

const buffer = Buffer.alloc(10);

const length = buffer.write('abcd', 8);

console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
// 打印: 2 bytes : abconst { Buffer } = require('buffer');

const buf = Buffer.alloc(256);

const len = buf.write('\u00bd + \u00bc = \u00be', 0);

console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
// 打印: 12 bytes: ½ + ¼ = ¾

const buffer = Buffer.alloc(10);

const length = buffer.write('abcd', 8);

console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
// 打印: 2 bytes : ab

buf.writeBigInt64BE(value[, offset])#

中英对照

  • value <bigint> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足:0 <= offset <= buf.length - 8默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为大端序写入 buf 中指定的 offset

value 被解释和写入为二进制补码有符号整数。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(8);

buf.writeBigInt64BE(0x0102030405060708n, 0);

console.log(buf);
// 打印: <Buffer 01 02 03 04 05 06 07 08>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(8);

buf.writeBigInt64BE(0x0102030405060708n, 0);

console.log(buf);
// 打印: <Buffer 01 02 03 04 05 06 07 08>

buf.writeBigInt64LE(value[, offset])#

中英对照

  • value <bigint> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足:0 <= offset <= buf.length - 8默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为小端序写入 buf 中指定的 offset

value 被解释和写入为二进制补码有符号整数。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(8);

buf.writeBigInt64LE(0x0102030405060708n, 0);

console.log(buf);
// 打印: <Buffer 08 07 06 05 04 03 02 01>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(8);

buf.writeBigInt64LE(0x0102030405060708n, 0);

console.log(buf);
// 打印: <Buffer 08 07 06 05 04 03 02 01>

buf.writeBigUInt64BE(value[, offset])#

中英对照

  • value <bigint> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足:0 <= offset <= buf.length - 8默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为大端序写入 buf 中指定的 offset

此函数也可在 writeBigUint64BE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(8);

buf.writeBigUInt64BE(0xdecafafecacefaden, 0);

console.log(buf);
// 打印: <Buffer de ca fa fe ca ce fa de>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(8);

buf.writeBigUInt64BE(0xdecafafecacefaden, 0);

console.log(buf);
// 打印: <Buffer de ca fa fe ca ce fa de>

buf.writeBigUInt64LE(value[, offset])#

中英对照

  • value <bigint> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足:0 <= offset <= buf.length - 8默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为小端序写入 buf 中指定的 offset

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(8);

buf.writeBigUInt64LE(0xdecafafecacefaden, 0);

console.log(buf);
// 打印: <Buffer de fa ce ca fe fa ca de>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(8);

buf.writeBigUInt64LE(0xdecafafecacefaden, 0);

console.log(buf);
// 打印: <Buffer de fa ce ca fe fa ca de>

此函数也可在 writeBigUint64LE 别名下使用。

buf.writeDoubleBE(value[, offset])#

中英对照

  • value <number> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 8默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为大端序写入 buf 中指定的 offsetvalue 必须是 JavaScript 数字 当 value 不是 JavaScript 数字时,则行为未定义。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(8);

buf.writeDoubleBE(123.456, 0);

console.log(buf);
// 打印: <Buffer 40 5e dd 2f 1a 9f be 77>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(8);

buf.writeDoubleBE(123.456, 0);

console.log(buf);
// 打印: <Buffer 40 5e dd 2f 1a 9f be 77>

buf.writeDoubleLE(value[, offset])#

中英对照

  • value <number> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 8默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为小端序写入 buf 中指定的 offsetvalue 必须是 JavaScript 数字 当 value 不是 JavaScript 数字时,则行为未定义。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(8);

buf.writeDoubleLE(123.456, 0);

console.log(buf);
// 打印: <Buffer 77 be 9f 1a 2f dd 5e 40>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(8);

buf.writeDoubleLE(123.456, 0);

console.log(buf);
// 打印: <Buffer 77 be 9f 1a 2f dd 5e 40>

buf.writeFloatBE(value[, offset])#

中英对照

  • value <number> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 4默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为大端序写入 buf 中指定的 offset。 当 value 不是 JavaScript 数字时,则行为未定义。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(4);

buf.writeFloatBE(0xcafebabe, 0);

console.log(buf);
// 打印: <Buffer 4f 4a fe bb>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(4);

buf.writeFloatBE(0xcafebabe, 0);

console.log(buf);
// 打印: <Buffer 4f 4a fe bb>

buf.writeFloatLE(value[, offset])#

中英对照

  • value <number> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 4默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为小端序写入 buf 中指定的 offset。 当 value 不是 JavaScript 数字时,则行为未定义。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(4);

buf.writeFloatLE(0xcafebabe, 0);

console.log(buf);
// 打印: <Buffer bb fe 4a 4f>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(4);

buf.writeFloatLE(0xcafebabe, 0);

console.log(buf);
// 打印: <Buffer bb fe 4a 4f>

buf.writeInt8(value[, offset])#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 1默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 写入 buf 中指定的 offsetvalue 必须是有效的有符号 8 位整数。 当 value 不是有符号的 8 位整数时,则行为未定义。

value 被解释和写入为二进制补码有符号整数。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(2);

buf.writeInt8(2, 0);
buf.writeInt8(-2, 1);

console.log(buf);
// 打印: <Buffer 02 fe>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(2);

buf.writeInt8(2, 0);
buf.writeInt8(-2, 1);

console.log(buf);
// 打印: <Buffer 02 fe>

buf.writeInt16BE(value[, offset])#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 2默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为大端序写入 buf 中指定的 offsetvalue 必须是有效的有符号 16 位整数。 当 value 不是有符号的 16 位整数时,则行为未定义。

value 被解释和写入为二进制补码有符号整数。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(2);

buf.writeInt16BE(0x0102, 0);

console.log(buf);
// 打印: <Buffer 01 02>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(2);

buf.writeInt16BE(0x0102, 0);

console.log(buf);
// 打印: <Buffer 01 02>

buf.writeInt16LE(value[, offset])#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 2默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为小端序写入 buf 中指定的 offsetvalue 必须是有效的有符号 16 位整数。 当 value 不是有符号的 16 位整数时,则行为未定义。

value 被解释和写入为二进制补码有符号整数。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(2);

buf.writeInt16LE(0x0304, 0);

console.log(buf);
// 打印: <Buffer 04 03>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(2);

buf.writeInt16LE(0x0304, 0);

console.log(buf);
// 打印: <Buffer 04 03>

buf.writeInt32BE(value[, offset])#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 4默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为大端序写入 buf 中指定的 offsetvalue 必须是有效的有符号 32 位整数。 当 value 不是有符号的 32 位整数时,则行为未定义。

value 被解释和写入为二进制补码有符号整数。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(4);

buf.writeInt32BE(0x01020304, 0);

console.log(buf);
// 打印: <Buffer 01 02 03 04>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(4);

buf.writeInt32BE(0x01020304, 0);

console.log(buf);
// 打印: <Buffer 01 02 03 04>

buf.writeInt32LE(value[, offset])#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 4默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为小端序写入 buf 中指定的 offsetvalue 必须是有效的有符号 32 位整数。 当 value 不是有符号的 32 位整数时,则行为未定义。

value 被解释和写入为二进制补码有符号整数。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(4);

buf.writeInt32LE(0x05060708, 0);

console.log(buf);
// 打印: <Buffer 08 07 06 05>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(4);

buf.writeInt32LE(0x05060708, 0);

console.log(buf);
// 打印: <Buffer 08 07 06 05>

buf.writeIntBE(value, offset, byteLength)#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - byteLength
  • byteLength <integer> 要写入的字节数。 必须满足 0 < byteLength <= 6
  • 返回: <integer> offset 加上写入的字节数。

valuebyteLength 个字节作为大端序写入 buf 中指定的 offset。 支持最高 48 位的精度。 当 value 不是有符号整数时,则行为未定义。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(6);

buf.writeIntBE(0x1234567890ab, 0, 6);

console.log(buf);
// 打印: <Buffer 12 34 56 78 90 ab>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(6);

buf.writeIntBE(0x1234567890ab, 0, 6);

console.log(buf);
// 打印: <Buffer 12 34 56 78 90 ab>

buf.writeIntLE(value, offset, byteLength)#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - byteLength
  • byteLength <integer> 要写入的字节数。 必须满足 0 < byteLength <= 6
  • 返回: <integer> offset 加上写入的字节数。

valuebyteLength 个字节作为小端序写入 buf 中指定的 offset。 支持最高 48 位的精度。 当 value 不是有符号整数时,则行为未定义。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(6);

buf.writeIntLE(0x1234567890ab, 0, 6);

console.log(buf);
// 打印: <Buffer ab 90 78 56 34 12>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(6);

buf.writeIntLE(0x1234567890ab, 0, 6);

console.log(buf);
// 打印: <Buffer ab 90 78 56 34 12>

buf.writeUInt8(value[, offset])#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 1默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 写入 buf 中指定的 offsetvalue 必须是有效的无符号 8 位整数。 当 value 不是无符号 8 位整数时,则行为未定义。

此函数也可在 writeUint8 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(4);

buf.writeUInt8(0x3, 0);
buf.writeUInt8(0x4, 1);
buf.writeUInt8(0x23, 2);
buf.writeUInt8(0x42, 3);

console.log(buf);
// 打印: <Buffer 03 04 23 42>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(4);

buf.writeUInt8(0x3, 0);
buf.writeUInt8(0x4, 1);
buf.writeUInt8(0x23, 2);
buf.writeUInt8(0x42, 3);

console.log(buf);
// 打印: <Buffer 03 04 23 42>

buf.writeUInt16BE(value[, offset])#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 2默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为大端序写入 buf 中指定的 offsetvalue 必须是有效的无符号 16 位整数。 当 value 不是无符号 16 位整数时,则行为未定义。

此函数也可在 writeUint16BE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(4);

buf.writeUInt16BE(0xdead, 0);
buf.writeUInt16BE(0xbeef, 2);

console.log(buf);
// 打印: <Buffer de ad be ef>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(4);

buf.writeUInt16BE(0xdead, 0);
buf.writeUInt16BE(0xbeef, 2);

console.log(buf);
// 打印: <Buffer de ad be ef>

buf.writeUInt16LE(value[, offset])#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 2默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为小端序写入 buf 中指定的 offsetvalue 必须是有效的无符号 16 位整数。 当 value 不是无符号 16 位整数时,则行为未定义。

此函数也可在 writeUint16LE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(4);

buf.writeUInt16LE(0xdead, 0);
buf.writeUInt16LE(0xbeef, 2);

console.log(buf);
// 打印: <Buffer ad de ef be>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(4);

buf.writeUInt16LE(0xdead, 0);
buf.writeUInt16LE(0xbeef, 2);

console.log(buf);
// 打印: <Buffer ad de ef be>

buf.writeUInt32BE(value[, offset])#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 4默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为大端序写入 buf 中指定的 offsetvalue 必须是有效的无符号 32 位整数。 当 value 不是无符号 32 位整数时,则行为未定义。

此函数也可在 writeUint32BE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(4);

buf.writeUInt32BE(0xfeedface, 0);

console.log(buf);
// 打印: <Buffer fe ed fa ce>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(4);

buf.writeUInt32BE(0xfeedface, 0);

console.log(buf);
// 打印: <Buffer fe ed fa ce>

buf.writeUInt32LE(value[, offset])#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - 4默认值: 0
  • 返回: <integer> offset 加上写入的字节数。

value 作为小端序写入 buf 中指定的 offsetvalue 必须是有效的无符号 32 位整数。 当 value 不是无符号 32 位整数时,则行为未定义。

此函数也可在 writeUint32LE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(4);

buf.writeUInt32LE(0xfeedface, 0);

console.log(buf);
// 打印: <Buffer ce fa ed fe>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(4);

buf.writeUInt32LE(0xfeedface, 0);

console.log(buf);
// 打印: <Buffer ce fa ed fe>

buf.writeUIntBE(value, offset, byteLength)#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - byteLength
  • byteLength <integer> 要写入的字节数。 必须满足 0 < byteLength <= 6
  • 返回: <integer> offset 加上写入的字节数。

valuebyteLength 个字节作为大端序写入 buf 中指定的 offset。 支持最高 48 位的精度。 当 value 不是无符号整数时,则行为未定义。

此函数也可在 writeUintBE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(6);

buf.writeUIntBE(0x1234567890ab, 0, 6);

console.log(buf);
// 打印: <Buffer 12 34 56 78 90 ab>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(6);

buf.writeUIntBE(0x1234567890ab, 0, 6);

console.log(buf);
// 打印: <Buffer 12 34 56 78 90 ab>

buf.writeUIntLE(value, offset, byteLength)#

中英对照

  • value <integer> 要写入 buf 的数字。
  • offset <integer> 开始写入之前要跳过的字节数。 必须满足 0 <= offset <= buf.length - byteLength
  • byteLength <integer> 要写入的字节数。 必须满足 0 < byteLength <= 6
  • 返回: <integer> offset 加上写入的字节数。

valuebyteLength 个字节作为小端序写入 buf 中指定的 offset。 支持最高 48 位的精度。 当 value 不是无符号整数时,则行为未定义。

此函数也可在 writeUintLE 别名下使用。

import { Buffer } from 'buffer';

const buf = Buffer.allocUnsafe(6);

buf.writeUIntLE(0x1234567890ab, 0, 6);

console.log(buf);
// 打印: <Buffer ab 90 78 56 34 12>const { Buffer } = require('buffer');

const buf = Buffer.allocUnsafe(6);

buf.writeUIntLE(0x1234567890ab, 0, 6);

console.log(buf);
// 打印: <Buffer ab 90 78 56 34 12>

new Buffer(array)#

中英对照

稳定性: 0 - 弃用: 改为使用 Buffer.from(array)

参见 Buffer.from(array)

new Buffer(arrayBuffer[, byteOffset[, length]])#

中英对照

参见 Buffer.from(arrayBuffer[, byteOffset[, length]])

new Buffer(buffer)#

中英对照

稳定性: 0 - 弃用: 改为使用 Buffer.from(buffer)

参见 Buffer.from(buffer)

new Buffer(size)#

中英对照

稳定性: 0 - 弃用: 改为使用 Buffer.alloc() (或 Buffer.allocUnsafe())。

  • size <integer> 新的 Buffer 所需的长度。

参见 Buffer.alloc()Buffer.allocUnsafe()。 构造函数的此变体等效于 Buffer.alloc()

new Buffer(string[, encoding])#

中英对照

  • string <string> 要编码的字符串。
  • encoding <string> string 的编码。 默认值: 'utf8'

参见 Buffer.from(string[, encoding])

缓冲区模块 API#

中英对照

虽然 Buffer 对象可作为全局对象使用,但还有其他与 Buffer 相关的 API 仅可通过使用 require('buffer') 访问的 buffer 模块使用。

buffer.atob(data)#

中英对照

稳定性: 3 - 旧版. 改为使用 Buffer.from(data, 'base64')

  • data <any> Base64 编码的输入字符串。

将 Base64 编码的数据字符串解码为字节,并使用 Latin-1 (ISO-8859-1) 将这些字节编码为字符串。

data 可以是任何可以强制转换为字符串的 JavaScript 值。

此函数仅用于与旧版 Web 平台 API 兼容,不应在新代码中使用,因为它们使用字符串表示二进制数据,并且早于 JavaScript 中引入类型化数组。 对于使用 Node.js API 运行的代码,base64 编码的字符串和二进制数据之间的转换应该使用 Buffer.from(str, 'base64')buf.toString('base64')

buffer.btoa(data)#

中英对照

稳定性: 3 - 旧版. 改为使用 buf.toString('base64')

  • data <any> ASCII (Latin1) 字符串。

使用 Latin-1 (ISO-8859) 将字符串解码为字节,并使用 Base64 将这些字节编码为字符串。

data 可以是任何可以强制转换为字符串的 JavaScript 值。

此函数仅用于与旧版 Web 平台 API 兼容,不应在新代码中使用,因为它们使用字符串表示二进制数据,并且早于 JavaScript 中引入类型化数组。 对于使用 Node.js API 运行的代码,base64 编码的字符串和二进制数据之间的转换应该使用 Buffer.from(str, 'base64')buf.toString('base64')

buffer.INSPECT_MAX_BYTES#

中英对照

返回调用 buf.inspect() 时将返回的最大字节数。 这可以被用户模块覆盖。 有关 buf.inspect() 行为的更多详细信息,请参阅 util.inspect()

buffer.kMaxLength#

中英对照

  • <integer> 单个 Buffer 实例允许的最大大小。

buffer.constants.MAX_LENGTH 的别名。

buffer.kStringMaxLength#

中英对照

  • <integer> 单个 string 实例允许的最大长度。

buffer.constants.MAX_STRING_LENGTH 的别名。

buffer.resolveObjectURL(id)#

中英对照

稳定性: 1 - 实验

  • id <string> 先前调用 URL.createObjectURL() 返回的 'blob:nodedata:... 网址字符串。
  • 返回: <Blob>

解析 'blob:nodedata:...',关联的使用先前调用 URL.createObjectURL() 注册的 <Blob> 对象。

buffer.transcode(source, fromEnc, toEnc)#

中英对照

将给定的 BufferUint8Array 实例从一种字符编码重新编码为另一种。 返回新的 Buffer 实例。

如果 fromEnctoEnc 指定无效的字符编码或不允许从 fromEnc 转换为 toEnc,则抛出错误。

buffer.transcode() 支持的编码有:'ascii''utf8''utf16le''ucs2''latin1''binary'

如果给定的字节序列不能在目标编码中充分表示,则转码过程将使用替换字符。 例如:

import { Buffer, transcode } from 'buffer';

const newBuf = transcode(Buffer.from('€'), 'utf8', 'ascii');
console.log(newBuf.toString('ascii'));
// 打印: '?'const { Buffer, transcode } = require('buffer');

const newBuf = transcode(Buffer.from('€'), 'utf8', 'ascii');
console.log(newBuf.toString('ascii'));
// 打印: '?'

由于欧元 () 符号在 US-ASCII 中无法表示,因此在转码后的 Buffer 中将其替换为 ?

SlowBuffer#

中英对照

稳定性: 0 - 弃用: 改为使用 Buffer.allocUnsafeSlow()

参见 Buffer.allocUnsafeSlow()。 从构造函数总是返回 Buffer 实例而不是 SlowBuffer 实例的意义上来说,这从来都不是一个类。

new SlowBuffer(size)#

中英对照

稳定性: 0 - 弃用: 改为使用 Buffer.allocUnsafeSlow()

  • size <integer> 新的 SlowBuffer 所需的长度。

参见 Buffer.allocUnsafeSlow()

缓冲区常量#

buffer.constants.MAX_LENGTH#

中英对照

  • <integer> 单个 Buffer 实例允许的最大大小。

在 32 位架构上,此值目前是 230 - 1(大约 1 GB)。

在 64 位架构上,此值目前是 232(大约 4 GB)。

它反映了引擎盖下的 v8::TypedArray::kMaxLength

此值也可用作 buffer.kMaxLength

buffer.constants.MAX_STRING_LENGTH#

中英对照

  • <integer> 单个 string 实例允许的最大长度。

表示 string 原语可以拥有的最大 length,以 UTF-16 代码单元计算。

此值可能取决于正在使用的 JS 引擎。

Buffer.from()、Buffer.alloc() 与 Buffer.allocUnsafe()#

中英对照

在 Node.js 6.0.0 之前的版本中,Buffer 实例是使用 Buffer 构造函数创建的,它根据提供的参数以不同的方式分配返回的 Buffer

  • 将数字作为第一个参数传给 Buffer()(例如 new Buffer(10))会分配指定大小的新 Buffer 对象。 在 Node.js 8.0.0 之前,为此类 Buffer 实例分配的内存未初始化并且可能包含敏感数据。 此类 Buffer 实例必须随后通过使用 buf.fill(0) 或在从 Buffer 读取数据之前写入整个 Buffer 来初始化。 虽然这种行为是为了提高性能,但开发经验表明,在创建快速但未初始化的 Buffer 与创建较慢但更安全的 Buffer 之间需要更明确的区别。 从 Node.js 8.0.0 开始,Buffer(num)new Buffer(num) 返回带有初始化内存的 Buffer
  • 传入字符串、数组或 Buffer 作为第一个参数会将传入的对象的数据复制到 Buffer
  • 传入 ArrayBufferSharedArrayBuffer 返回 Buffer,它与给定的数组缓冲区共享分配的内存。

由于 new Buffer() 的行为因第一个参数的类型而异,因此当未执行参数验证或 Buffer 初始化时,可能会无意中将安全性和可靠性问题引入到应用程序中。

例如,如果攻击者可以使应用程序接收到预期为字符串的数字,则应用程序可能会调用 new Buffer(100) 而不是 new Buffer("100"),从而导致它分配 100 字节的缓冲区,而不是分配内容为 "100" 的 3 字节缓冲区。 这通常可以使用 JSON API 调用实现。 由于 JSON 区分数字和字符串类型,因此它允许在未充分验证其输入的天真编写的应用程序可能期望始终接收字符串的情况下注入数字。 在 Node.js 8.0.0 之前,100 字节的缓冲区可能包含任意预先存在的内存数据,因此可用于向远程攻击者公开内存机密。 从 Node.js 8.0.0 开始,不会发生内存暴露,因为数据是零填充的。 但是,其他攻击仍然是可能的,例如导致服务器分配非常大的缓冲区,导致性能下降或因内存耗尽而崩溃。

为了使 Buffer 实例的创建更可靠且不易出错,new Buffer() 构造函数的各种形式已被弃用,并由单独的 Buffer.from()Buffer.alloc()Buffer.allocUnsafe() 方法取代。

开发人员应将 new Buffer() 构造函数的所有现有用途迁移到这些新 API 之一。

如果 size 小于或等于 Buffer.poolSize 的一半,则 Buffer.allocUnsafe()Buffer.from(array) 返回的 Buffer 实例可以从共享内部内存池中分配。 Buffer.allocUnsafeSlow() 返回的实例从不使用共享内部内存池。

--zero-fill-buffers 命令行选项#

中英对照

默认情况下,可以使用 --zero-fill-buffers 命令行选项启动 Node.js 以导致所有新分配的 Buffer 实例在创建时被零填充。 如果没有该选项,则使用 Buffer.allocUnsafe()Buffer.allocUnsafeSlow()new SlowBuffer(size) 创建的缓冲区不会填零。 使用此标志会对性能产生可衡量的负面影响。 仅在必要时使用 --zero-fill-buffers 选项以强制新分配的 Buffer 实例不能包含可能敏感的旧数据。

$ node --zero-fill-buffers
> Buffer.allocUnsafe(5);
<Buffer 00 00 00 00 00>

Buffer.allocUnsafe() 与 Buffer.allocUnsafeSlow() 不安全的原因#

中英对照

调用 Buffer.allocUnsafe()Buffer.allocUnsafeSlow() 时,分配的内存段未初始化(未清零)。 虽然这种设计使内存分配非常快,但分配的内存段可能包含潜在敏感的旧数据。 使用 Buffer.allocUnsafe() 创建的 Buffer 而不完全覆盖内存可以允许在读取 Buffer 内存时泄漏这些旧数据。

虽然使用 Buffer.allocUnsafe() 有明显的性能优势,但必须格外小心,以避免将安全漏洞引入应用程序。

返回顶部