node-buffertools 技术文档

1. 安装指南

使用 npm 安装

npm install buffertools

从源码安装

node-gyp configure
node-gyp build

安装完成后，您可以在项目中引入该模块。

2. 项目的使用说明

扩展 Buffer 原型

如果您希望扩展 Buffer 类的原型，可以使用以下代码：

require('buffertools').extend();  // 扩展 Buffer.prototype
var buf = new Buffer(42);         // 创建一个 42 字节的缓冲区
buf.clear();                      // 清空缓冲区

不扩展 Buffer 原型

如果您不希望扩展 Buffer 类的原型，可以使用以下代码：

var buffertools = require('buffertools');
var buf = new Buffer(42);
buffertools.clear(buf);

3. 项目 API 使用文档

buffertools.extend([object], [object...])

扩展传入的对象，使其具有 buffertools 的方法。如果没有传入参数，默认扩展 Buffer.prototype 和 SlowBuffer.prototype。

Buffer#clear() / buffertools.clear(buffer)

清空缓冲区，等同于 Buffer#fill(0)。返回缓冲区对象，以便链式调用。

Buffer#compare(buffer|string) / buffertools.compare(buffer, buffer|string)

按字典序比较两个缓冲区。返回一个小于零的数表示 a < b，零表示 a == b，大于零的数表示 a > b。

Buffer#concat(a, b, c, ...) / buffertools.concat(a, b, c, ...)

连接两个或多个缓冲区/字符串并返回结果。

Buffer#equals(buffer|string) / buffertools.equals(buffer, buffer|string)

如果缓冲区与参数相等，返回 true，否则返回 false。

Buffer#fill(integer|string|buffer) / buffertools.fill(buffer, integer|string|buffer)

用参数填充缓冲区（如有必要，重复填充）。返回缓冲区对象，以便链式调用。

Buffer#fromHex() / buffertools.fromHex(buffer)

假设缓冲区包含十六进制数据（无空格），将其解码为二进制数据。返回一个新的缓冲区。

Buffer#indexOf(buffer|string, [start=0]) / buffertools.indexOf(buffer, buffer|string, [start=0])

从偏移量 start 开始，搜索缓冲区中第一次出现的参数。返回零基索引，如果未找到则返回 -1。

Buffer#reverse() / buffertools.reverse(buffer)

就地反转缓冲区的内容。

Buffer#toHex() / buffertools.toHex(buffer)

返回缓冲区内容的十六进制编码字符串。

4. 项目安装方式

使用 npm 安装

npm install buffertools

从源码安装

node-gyp configure
node-gyp build

安装完成后，您可以在项目中引入该模块。