Node.js v0.10.18 手册 & 文档

Buffer#

稳定度: 3 - 稳定

Pure JavaScript is Unicode friendly but not nice to binary data. When dealing with TCP streams or the file system, it's necessary to handle octet streams. Node has several strategies for manipulating, creating, and consuming octet streams.

纯javascript对Unicode比较友好，但是无法很好地处理二进制数据。当我们面对TCP流或者文件系统的时候，是需要处理八位字节流的。Node有几种操作，创建和消化八位字节流的策略。

Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized.

原始数据保存在 Buffer 类的实例中。一个 Buffer 实例类似于一个整数数组，但对应者 V8 堆之外的一个原始内存分配区域。一个 Buffer 的大小不可变。

The Buffer class is a global, making it very rare that one would need to ever require('buffer').

Buffer 类是一个全局的类，所以它很罕有地不需要require语句就可以调用。

Converting between Buffers and JavaScript string objects requires an explicit encoding method. Here are the different string encodings.

在Buffers和JavaScript string转换时，需要明确的一个编码方法。下面是一些不同的string编码。

'ascii' - for 7 bit ASCII data only. This encoding method is very fast, and will strip the high bit if set.
'ascii' - 仅适用 7 bit ASCII 格式数据。这个编码方式非常快速，而且会剥离设置过高的bit。
'utf8' - Multibyte encoded Unicode characters. Many web pages and other document formats use UTF-8.
'utf8' - 多字节编码 Unicode字符。很多网页或者其他文档的编码格式都是使用 UTF-8的。
'utf16le' - 2 or 4 bytes, little endian encoded Unicode characters. Surrogate pairs (U+10000 to U+10FFFF) are supported.
'utf16le' - 2 或者 4 字节, Little Endian (LE) 编码Unicode字符。代理对 (U+10000 to U+10FFFF) 是支持的.（BE和LE表示大端和小端，Little-Endian就是低位字节排放在内存的低地址端，高位字节排放在内存的高地址端；Big-Endian就是高位字节排放在内存的低地址端，低位字节排放在内存的高地址端；下同）
'ucs2' - Alias of 'utf16le'.
'ucs2' - 'utf16le'的别名.
'base64' - Base64 string encoding.
'base64' - Base64 字符串编码。
'binary' - A way of encoding raw binary data into strings by using only the first 8 bits of each character. This encoding method is deprecated and should be avoided in favor of Buffer objects where possible. This encoding will be removed in future versions of Node.
'binary' - 一个将原始2进制数据编码为字符串的方法，仅使用每个字符的前8bits。这个编码方式已经被弃用而且应该被避免，尽可能的使用Buffer对象。这个编码方式将会在未来的Node版本中移除。
'hex' - Encode each byte as two hexadecimal characters.
'hex' - 把每个byte编码成2个十六进制字符

类: Buffer#

The Buffer class is a global type for dealing with binary data directly. It can be constructed in a variety of ways.

Buffer 类是一个全局变量类型，用来直接处理2进制数据的。它能够使用多种方式构建。

new Buffer(size)#

size Number
size Number

Allocates a new buffer of size octets.

分配一个新的 buffer 大小是 size 的8位字节.

new Buffer(array)#

array Array
array Array

Allocates a new buffer using an array of octets.

分配一个新的 buffer 使用一个8位字节 array 数组.

new Buffer(str, [encoding])#

str String - string to encode.
encoding String - encoding to use, Optional.
str String类型 - 需要存入buffer的string字符串.
encoding String类型 - 使用什么编码方式，参数可选.

Allocates a new buffer containing the given str. encoding defaults to 'utf8'.

分配一个新的 buffer ，其中包含着给定的 str字符串. encoding 编码方式默认是：'utf8'.

类方法: Buffer.isEncoding(encoding)#

encoding String The encoding string to test
encoding String 用来测试给定的编码字符串

Returns true if the encoding is a valid encoding argument, or false otherwise.

如果给定的编码 encoding 是有效的，返回 true，否则返回 false。

类方法: Buffer.isBuffer(obj)#

obj Object
Return: Boolean
obj Object
返回: Boolean

Tests if obj is a Buffer.

测试这个 obj 是否是一个 Buffer.

类方法: Buffer.byteLength(string, [encoding])#

string String
encoding String, Optional, Default: 'utf8'
Return: Number
string String类型
encoding String类型, 可选参数, 默认是: 'utf8'
Return: Number类型

Gives the actual byte length of a string. encoding defaults to 'utf8'. This is not the same as String.prototype.length since that returns the number of characters in a string.

将会返回这个字符串真实byte长度。 encoding 编码默认是： 'utf8'. 这个和 String.prototype.length 是不一样的，因为那个方法返回这个字符串中有几个字符的数量。（译者：当用户在写http响应头Cotent-Length的时候，千万记得一定要用 Buffer.byteLength 方法，不要使用 String.prototype.length ）

Example:

示例：

// ½ + ¼ = ¾: 9 characters, 12 bytes

类方法: Buffer.concat(list, [totalLength])#

list Array List of Buffer objects to concat
totalLength Number Total length of the buffers when concatenated
list Array数组类型，Buffer数组，用于被连接。
totalLength Number类型上述Buffer数组的所有Buffer的总大小。（译者：注意这里的totalLength不是数组长度是数组里Buffer实例的大小总和）

Returns a buffer which is the result of concatenating all the buffers in the list together.

返回一个保存着将传入buffer数组中所有buffer对象拼接在一起的buffer对象。（译者：有点拗口，其实就是将数组中所有的buffer实例通过复制拼接在一起）

If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer.

如果传入的数组没有内容，或者 totalLength 参数是0，那将返回一个zero-length的buffer。

If the list has exactly one item, then the first item of the list is returned.

如果数组中只有一项，那么这第一项就会被返回。

If the list has more than one item, then a new Buffer is created.

如果数组中的项多于一个，那么一个新的Buffer实例将被创建。

If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly.

如果 totalLength 参数没有提供，虽然会从buffer数组中计算读取，但是会增加一个额外的循环来计算它，所以提供一个明确的 totalLength 参数将会更快。

buf.length#

Number
Number类型

The size of the buffer in bytes. Note that this is not necessarily the size of the contents. length refers to the amount of memory allocated for the buffer object. It does not change when the contents of the buffer are changed.

这个buffer的bytes大小。注意这未必是这buffer里面内容的大小。length 的依据是buffer对象所分配的内存数值，它不会随着这个buffer对象内容的改变而改变。

// 1234
// 1234

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

string String - data to be written to buffer
offset Number, Optional, Default: 0
length Number, Optional, Default: buffer.length - offset
encoding String, Optional, Default: 'utf8'
string String类型 - 将要被写入 buffer 的数据
offset Number类型, 可选参数, 默认: 0
length Number类型, 可选参数, 默认: buffer.length - offset
encoding String类型, 可选参数, 默认: 'utf8'

Writes string to the buffer at offset using the given encoding. offset defaults to 0, encoding defaults to 'utf8'. length is the number of bytes to write. Returns number of octets written. If buffer did not contain enough space to fit the entire string, it will write a partial amount of the string. length defaults to buffer.length - offset. The method will not write partial characters.

根据参数 offset 偏移量和指定的encoding编码方式，将参数 string 数据写入buffer。 offset偏移量默认是 0, encoding编码方式默认是 'utf8'。 length长度是将要写入的字符串的bytes大小。返回number类型，表示多少8位字节流被写入了。如果buffer 没有足够的空间来放入整个string，它将只会写入部分的字符串。 length 默认是 buffer.length - offset。这个方法不会出现写入部分字符。

buf = new Buffer(256);
len = buf.write('\u00bd + \u00bc = \u00be', 0);
console.log(len + " bytes: " + buf.toString('utf8', 0, len));

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

encoding String, Optional, Default: 'utf8'
start Number, Optional, Default: 0
end Number, Optional, Default: buffer.length
encoding String类型, 可选参数, 默认: 'utf8'
start Number类型, 可选参数, 默认: 0
end Number类型, 可选参数, 默认: buffer.length

Decodes and returns a string from buffer data encoded with encoding (defaults to 'utf8') beginning at start (defaults to 0) and ending at end (defaults to buffer.length).

根据 encoding参数（默认是 'utf8'）返回一个解码的 string 类型。还会根据传入的参数 start (默认是0) 和 end (默认是 buffer.length)作为取值范围。

See buffer.write() example, above.

查看上面buffer.write() 的例子.

buf.toJSON()#

Returns a JSON-representation of the Buffer instance. JSON.stringify implicitly calls this function when stringifying a Buffer instance.

返回一个 JSON表示的Buffer实例。JSON.stringify将会默认调用来字符串序列化这个Buffer实例。

Example:

示例：

console.log(copy);
// <Buffer 74 65 73 74>

buf[index]#

Get and set the octet at index. The values refer to individual bytes, so the legal range is between 0x00 and 0xFF hex or 0 and 255.

获取或者设置在指定index索引位置的8位字节。这个值是指单个字节，所以这个值必须在合法的范围，16进制的0x00 到0xFF，或者0 到255。

Example: copy an ASCII string into a buffer, one byte at a time:

例子: 拷贝一个 ASCII 编码的 string 字符串到一个 buffer, 一次一个 byte 进行拷贝:

// node.js

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

targetBuffer Buffer object - Buffer to copy into
targetStart Number, Optional, Default: 0
sourceStart Number, Optional, Default: 0
sourceEnd Number, Optional, Default: buffer.length
targetBuffer Buffer 类型对象 - 将要进行拷贝的Buffer
targetStart Number类型, 可选参数, 默认: 0
sourceStart Number类型, 可选参数, 默认: 0
sourceEnd Number类型, 可选参数, 默认: buffer.length

Does copy between buffers. The source and target regions can be overlapped. targetStart and sourceStart default to 0. sourceEnd defaults to buffer.length.

进行buffer的拷贝，源和目标可以是重叠的。 targetStart 目标开始偏移和sourceStart源开始偏移默认都是 0. sourceEnd 源结束位置偏移默认是源的长度 buffer.length.

All values passed that are undefined/NaN or are out of bounds are set equal to their respective defaults.

如果传递的值是undefined/NaN 或者是 out of bounds 超越边界的，就将设置为他们的默认值。（译者：这个默认值下面有的例子有说明）

Example: build two Buffers, then copy buf1 from byte 16 through byte 19 into buf2, starting at the 8th byte in buf2.

例子: 创建2个Buffer，然后把将buf1的16位到19位拷贝到 buf2中，并且从buf2的第8位开始拷贝。

// !!!!!!!!qrst!!!!!!!!!!!!!

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

start Number, Optional, Default: 0
end Number, Optional, Default: buffer.length
start Number类型, 可选参数, 默认: 0
end Number类型, 可选参数, 默认: buffer.length

Returns a new buffer which references the same memory as the old, but offset and cropped by the start (defaults to 0) and end (defaults to buffer.length) indexes. Negative indexes start from the end of the buffer.

返回一个新的buffer，这个buffer将会和老的buffer引用相同的内存地址，只是根据 start (默认是 0) 和end (默认是buffer.length) 偏移和裁剪了索引。负的索引是从buffer尾部开始计算的。

Modifying the new buffer slice will modify memory in the original buffer!

修改这个新的buffer实例slice切片，也会改变原来的buffer

Example: build a Buffer with the ASCII alphabet, take a slice, then modify one byte from the original Buffer.

例子: 创建一个ASCII 字母的 Buffer，对它slice切片，然后修改源Buffer上的一个byte。

// abc
// !bc

buf.readUInt8(offset, [noAssert])#

offset Number
noAssert Boolean, Optional, Default: false
Return: Number
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false
Return: Number类型

Reads an unsigned 8 bit integer from the buffer at the specified offset.

从这个buffer对象里，根据指定的偏移量，读取一个 unsigned 8 bit integer整形。

Set noAssert to true to skip validation of offset. This means that offset may be beyond the end of the buffer. Defaults to false.

设置参数 noAssert为true表示忽略验证offset偏移量参数。这意味着 offset可能会超出buffer的末尾。默认是 false。

Example:

示例：

// 0x3
// 0x4
// 0x23
// 0x42

buf.readUInt16LE(offset, [noAssert])#

buf.readUInt16BE(offset, [noAssert])#

buf.readUInt16LE(offset, [noAssert])#

buf.readUInt16BE(offset, [noAssert])#

offset Number
noAssert Boolean, Optional, Default: false
Return: Number
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false
Return: Number类型

Reads an unsigned 16 bit integer from the buffer at the specified offset with specified endian format.

从这个buffer对象里，根据指定的偏移量，使用特殊的 endian字节序格式读取一个 unsigned 16 bit integer。

Set noAssert to true to skip validation of offset. This means that offset may be beyond the end of the buffer. Defaults to false.

设置参数 noAssert为true表示忽略验证offset偏移量参数。这意味着 offset可能会超出buffer的末尾。默认是 false。

Example:

示例：

// 0x0304
// 0x0403
// 0x0423
// 0x2304
// 0x2342
// 0x4223

buf.readUInt32LE(offset, [noAssert])#

buf.readUInt32BE(offset, [noAssert])#

buf.readUInt32LE(offset, [noAssert])#

buf.readUInt32BE(offset, [noAssert])#

offset Number
noAssert Boolean, Optional, Default: false
Return: Number
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false
Return: Number类型

Reads an unsigned 32 bit integer from the buffer at the specified offset with specified endian format.

从这个buffer对象里，根据指定的偏移量，使用指定的 endian字节序格式读取一个 unsigned 32 bit integer。

Set noAssert to true to skip validation of offset. This means that offset may be beyond the end of the buffer. Defaults to false.

设置参数 noAssert为true表示忽略验证offset偏移量参数。这意味着 offset可能会超出buffer的末尾。默认是 false。

Example:

示例：

// 0x03042342
// 0x42230403

buf.readInt8(offset, [noAssert])#

offset Number
noAssert Boolean, Optional, Default: false
Return: Number
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false
Return: Number类型

Reads a signed 8 bit integer from the buffer at the specified offset.

从这个buffer对象里，根据指定的偏移量，读取一个 signed 8 bit integer。

Set noAssert to true to skip validation of offset. This means that offset may be beyond the end of the buffer. Defaults to false.

设置参数 noAssert为true表示忽略验证offset偏移量参数。这意味着 offset可能会超出buffer的末尾。默认是 false。

Works as buffer.readUInt8, except buffer contents are treated as two's complement signed values.

和 buffer.readUInt8一样的返回，除非buffer中包含了有作为2的补码的有符号值。

buf.readInt16LE(offset, [noAssert])#

buf.readInt16BE(offset, [noAssert])#

buf.readInt16LE(offset, [noAssert])#

buf.readInt16BE(offset, [noAssert])#

offset Number
noAssert Boolean, Optional, Default: false
Return: Number
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false
Return: Number类型

Reads a signed 16 bit integer from the buffer at the specified offset with specified endian format.

从这个buffer对象里，根据指定的偏移量，使用特殊的 endian字节序格式读取一个 signed 16 bit integer。

Set noAssert to true to skip validation of offset. This means that offset may be beyond the end of the buffer. Defaults to false.

设置参数 noAssert为true表示忽略验证offset偏移量参数。这意味着 offset可能会超出buffer的末尾。默认是 false。

Works as buffer.readUInt16*, except buffer contents are treated as two's complement signed values.

和 buffer.readUInt16一样返回，除非buffer中包含了有作为2的补码的有符号值。

buf.readInt32LE(offset, [noAssert])#

buf.readInt32BE(offset, [noAssert])#

buf.readInt32LE(offset, [noAssert])#

buf.readInt32BE(offset, [noAssert])#

offset Number
noAssert Boolean, Optional, Default: false
Return: Number
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false
Return: Number类型

Reads a signed 32 bit integer from the buffer at the specified offset with specified endian format.

从这个buffer对象里，根据指定的偏移量，使用指定的 endian字节序格式读取一个 signed 32 bit integer。

Set noAssert to true to skip validation of offset. This means that offset may be beyond the end of the buffer. Defaults to false.

设置参数 noAssert为true表示忽略验证offset偏移量参数。这意味着 offset可能会超出buffer的末尾。默认是 false。

Works as buffer.readUInt32*, except buffer contents are treated as two's complement signed values.

和 buffer.readUInt32一样返回，除非buffer中包含了有作为2的补码的有符号值。

buf.readFloatLE(offset, [noAssert])#

buf.readFloatBE(offset, [noAssert])#

buf.readFloatLE(offset, [noAssert])#

buf.readFloatBE(offset, [noAssert])#

offset Number
noAssert Boolean, Optional, Default: false
Return: Number
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false
Return: Number类型

Reads a 32 bit float from the buffer at the specified offset with specified endian format.

从这个buffer对象里，根据指定的偏移量，使用指定的 endian字节序格式读取一个 32 bit float。

Set noAssert to true to skip validation of offset. This means that offset may be beyond the end of the buffer. Defaults to false.

设置参数 noAssert为true表示忽略验证offset偏移量参数。这意味着 offset可能会超出buffer的末尾。默认是 false。

Example:

示例：

// 0x01

buf.readDoubleLE(offset, [noAssert])#

buf.readDoubleBE(offset, [noAssert])#

buf.readDoubleLE(offset, [noAssert])#

buf.readDoubleBE(offset, [noAssert])#

offset Number
noAssert Boolean, Optional, Default: false
Return: Number
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false
Return: Number类型

Reads a 64 bit double from the buffer at the specified offset with specified endian format.

从这个buffer对象里，根据指定的偏移量，使用指定的 endian字节序格式读取一个 64 bit double。

Set noAssert to true to skip validation of offset. This means that offset may be beyond the end of the buffer. Defaults to false.

设置参数 noAssert为true表示忽略验证offset偏移量参数。这意味着 offset可能会超出buffer的末尾。默认是 false。

Example:

示例：

// 0.3333333333333333

buf.writeUInt8(value, offset, [noAssert])#

value Number
offset Number
noAssert Boolean, Optional, Default: false
value Number类型
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false

Writes value to the buffer at the specified offset. Note, value must be a valid unsigned 8 bit integer.

根据指定的offset偏移量将value写入buffer。注意：value 必须是一个合法的unsigned 8 bit integer.

Set noAssert to true to skip validation of value and offset. This means that value may be too large for the specific function and offset may be beyond the end of the buffer leading to the values being silently dropped. This should not be used unless you are certain of correctness. Defaults to false.

设置参数 noAssert为true表示忽略验证value和offset参数。这意味着 value可能过大，或者offset可能会超出buffer的末尾造成value被丢弃。这个参数除了你非常有把握，否则不应该使用它。默认是 false。`.

Example:

示例：

// <Buffer 03 04 23 42>

buf.writeUInt16LE(value, offset, [noAssert])#

buf.writeUInt16BE(value, offset, [noAssert])#

buf.writeUInt16LE(value, offset, [noAssert])#

buf.writeUInt16BE(value, offset, [noAssert])#

value Number
offset Number
noAssert Boolean, Optional, Default: false
value Number类型
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false

Writes value to the buffer at the specified offset with specified endian format. Note, value must be a valid unsigned 16 bit integer.

根据指定的offset偏移量和指定的 endian字节序格式将value写入buffer。注意：value 必须是一个合法的unsigned 16 bit integer.

Example:

示例：

// <Buffer de ad be ef>
// <Buffer ad de ef be>

buf.writeUInt32LE(value, offset, [noAssert])#

buf.writeUInt32BE(value, offset, [noAssert])#

buf.writeUInt32LE(value, offset, [noAssert])#

buf.writeUInt32BE(value, offset, [noAssert])#

value Number
offset Number
noAssert Boolean, Optional, Default: false
value Number类型
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false

Writes value to the buffer at the specified offset with specified endian format. Note, value must be a valid unsigned 32 bit integer.

根据指定的offset偏移量和指定的 endian字节序格式将value写入buffer。注意：value 必须是一个合法的unsigned 32 bit integer。

Example:

示例：

// <Buffer fe ed fa ce>
// <Buffer ce fa ed fe>

buf.writeInt8(value, offset, [noAssert])#

value Number
offset Number
noAssert Boolean, Optional, Default: false
value Number类型
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false

Writes value to the buffer at the specified offset. Note, value must be a valid signed 8 bit integer.

根据指定的offset偏移量将value写入buffer。注意：value 必须是一个合法的 signed 8 bit integer。

Works as buffer.writeUInt8, except value is written out as a two's complement signed integer into buffer.

和 buffer.writeUInt8 一样工作，除非是把有2的补码的 signed integer 有符号整形写入buffer。

buf.writeInt16LE(value, offset, [noAssert])#

buf.writeInt16BE(value, offset, [noAssert])#

buf.writeInt16LE(value, offset, [noAssert])#

buf.writeInt16BE(value, offset, [noAssert])#

value Number
offset Number
noAssert Boolean, Optional, Default: false
value Number类型
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false

Writes value to the buffer at the specified offset with specified endian format. Note, value must be a valid signed 16 bit integer.

根据指定的offset偏移量和指定的 endian字节序格式将value写入buffer。注意：value 必须是一个合法的 signed 16 bit integer。

Works as buffer.writeUInt16*, except value is written out as a two's complement signed integer into buffer.

和 buffer.writeUInt16* 一样工作，除非是把有2的补码的 signed integer 有符号整形写入buffer。

buf.writeInt32LE(value, offset, [noAssert])#

buf.writeInt32BE(value, offset, [noAssert])#

buf.writeInt32LE(value, offset, [noAssert])#

buf.writeInt32BE(value, offset, [noAssert])#

value Number
offset Number
noAssert Boolean, Optional, Default: false
value Number类型
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false

Writes value to the buffer at the specified offset with specified endian format. Note, value must be a valid signed 32 bit integer.

根据指定的offset偏移量和指定的 endian字节序格式将value写入buffer。注意：value 必须是一个合法的 signed 32 bit integer。

Works as buffer.writeUInt32*, except value is written out as a two's complement signed integer into buffer.

和 buffer.writeUInt32* 一样工作，除非是把有2的补码的 signed integer 有符号整形写入buffer。

buf.writeFloatLE(value, offset, [noAssert])#

buf.writeFloatBE(value, offset, [noAssert])#

buf.writeFloatLE(value, offset, [noAssert])#

buf.writeFloatBE(value, offset, [noAssert])#

value Number
offset Number
noAssert Boolean, Optional, Default: false
value Number类型
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false

Writes value to the buffer at the specified offset with specified endian format. Note, behavior is unspecified if value is not a 32 bit float.

根据指定的offset偏移量和指定的 endian字节序格式将value写入buffer。注意：当value 不是一个 32 bit float 类型的值时，结果将是不确定的。

Example:

示例：

// <Buffer 4f 4a fe bb>
// <Buffer bb fe 4a 4f>

buf.writeDoubleLE(value, offset, [noAssert])#

buf.writeDoubleBE(value, offset, [noAssert])#

buf.writeDoubleLE(value, offset, [noAssert])#

buf.writeDoubleBE(value, offset, [noAssert])#

value Number
offset Number
noAssert Boolean, Optional, Default: false
value Number类型
offset Number类型
noAssert Boolean类型, 可选参数, 默认: false

Writes value to the buffer at the specified offset with specified endian format. Note, value must be a valid 64 bit double.

根据指定的offset偏移量和指定的 endian字节序格式将value写入buffer。注意：value 必须是一个有效的 64 bit double 类型的值。

Example:

示例：

// <Buffer 43 eb d5 b7 dd f9 5f d7>
// <Buffer d7 5f f9 dd b7 d5 eb 43>

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

value
offset Number, Optional
end Number, Optional
value
offset Number类型, 可选参数
end Number类型, 可选参数

Fills the buffer with the specified value. If the offset (defaults to 0) and end (defaults to buffer.length) are not given it will fill the entire buffer.

使用指定的value来填充这个buffer。如果 offset (默认是 0) 并且 end (默认是 buffer.length) 没有明确给出，就会填充整个buffer。（译者：buf.fill调用的是C语言的memset函数非常高效）

var b = new Buffer(50);
b.fill("h");

buffer.INSPECT_MAX_BYTES#

Number, Default: 50
Number类型, 默认: 50

How many bytes will be returned when buffer.inspect() is called. This can be overridden by user modules.

设置当调用buffer.inspect()方法后，多少bytes将会返回。这个值可以被用户模块重写。（译者：这个值主要用在当我们打印console.log(buf)时，设置返回多少长度内容）

Note that this is a property on the buffer module returned by require('buffer'), not on the Buffer global, or a buffer instance.

注意这个属性是require('buffer')模块返回的。这个属性不是在全局变量Buffer中，也不再buffer的实例里。

类: SlowBuffer#

Returns an un-pooled Buffer.

返回一个不被池管理的 Buffer。

In order to avoid the garbage collection overhead of creating many individually allocated Buffers, by default allocations under 4KB are sliced from a single larger allocated object. This approach improves both performance and memory usage since v8 does not need to track and cleanup as many Persistent objects.

为了避免创建大量独立分配的 Buffer 带来的垃圾回收开销，默认情况下小于 4KB 的空间都是切割自一个较大的独立对象。这种策略既提高了性能也改善了内存使用，因为 V8 不需要跟踪和清理很多 Persistent 对象。

In the case where a developer may need to retain a small chunk of memory from a pool for an indeterminate amount of time it may be appropriate to create an un-pooled Buffer instance using SlowBuffer and copy out the relevant bits.

当开发者需要将池中一小块数据保留不确定的一段时间，较为妥当的办法是用 SlowBuffer 创建一个不被池管理的 Buffer 实例并将相应数据拷贝出来。

socket.on('readable', function() {
  var data = socket.read();
  // 为需要保留的数据分配内存
  var sb = new SlowBuffer(10);
  // 将数据拷贝到新的空间中
  data.copy(sb, 0, 0, 10);
  store.push(sb);
});

Though this should used sparingly and only be a last resort after a developer has actively observed undue memory retention in their applications.

请谨慎使用，仅作为开发者频繁观察到他们的应用中过度的内存保留时的最后手段。

目录

Buffer#

类: Buffer#

new Buffer(size)#

new Buffer(array)#

new Buffer(str, [encoding])#

类方法: Buffer.isEncoding(encoding)#

类方法: Buffer.isBuffer(obj)#

类方法: Buffer.byteLength(string, [encoding])#

类方法: Buffer.concat(list, [totalLength])#

buf.length#

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

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

buf.toJSON()#

buf[index]#

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

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

buf.readUInt8(offset, [noAssert])#

buf.readUInt16LE(offset, [noAssert])#

buf.readUInt16BE(offset, [noAssert])#

buf.readUInt16LE(offset, [noAssert])#

buf.readUInt16BE(offset, [noAssert])#

buf.readUInt32LE(offset, [noAssert])#

buf.readUInt32BE(offset, [noAssert])#

buf.readUInt32LE(offset, [noAssert])#

buf.readUInt32BE(offset, [noAssert])#

buf.readInt8(offset, [noAssert])#

buf.readInt16LE(offset, [noAssert])#

buf.readInt16BE(offset, [noAssert])#

buf.readInt16LE(offset, [noAssert])#

buf.readInt16BE(offset, [noAssert])#

buf.readInt32LE(offset, [noAssert])#

buf.readInt32BE(offset, [noAssert])#

buf.readInt32LE(offset, [noAssert])#

buf.readInt32BE(offset, [noAssert])#

buf.readFloatLE(offset, [noAssert])#

buf.readFloatBE(offset, [noAssert])#

buf.readFloatLE(offset, [noAssert])#

buf.readFloatBE(offset, [noAssert])#

buf.readDoubleLE(offset, [noAssert])#

buf.readDoubleBE(offset, [noAssert])#

buf.readDoubleLE(offset, [noAssert])#

buf.readDoubleBE(offset, [noAssert])#

buf.writeUInt8(value, offset, [noAssert])#

buf.writeUInt16LE(value, offset, [noAssert])#

buf.writeUInt16BE(value, offset, [noAssert])#

buf.writeUInt16LE(value, offset, [noAssert])#

buf.writeUInt16BE(value, offset, [noAssert])#

buf.writeUInt32LE(value, offset, [noAssert])#

buf.writeUInt32BE(value, offset, [noAssert])#

buf.writeUInt32LE(value, offset, [noAssert])#

buf.writeUInt32BE(value, offset, [noAssert])#

buf.writeInt8(value, offset, [noAssert])#

buf.writeInt16LE(value, offset, [noAssert])#

buf.writeInt16BE(value, offset, [noAssert])#

buf.writeInt16LE(value, offset, [noAssert])#

buf.writeInt16BE(value, offset, [noAssert])#

buf.writeInt32LE(value, offset, [noAssert])#

buf.writeInt32BE(value, offset, [noAssert])#

buf.writeInt32LE(value, offset, [noAssert])#

buf.writeInt32BE(value, offset, [noAssert])#

buf.writeFloatLE(value, offset, [noAssert])#

buf.writeFloatBE(value, offset, [noAssert])#

buf.writeFloatLE(value, offset, [noAssert])#

buf.writeFloatBE(value, offset, [noAssert])#

buf.writeDoubleLE(value, offset, [noAssert])#

buf.writeDoubleBE(value, offset, [noAssert])#

buf.writeDoubleLE(value, offset, [noAssert])#

buf.writeDoubleBE(value, offset, [noAssert])#

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

buffer.INSPECT_MAX_BYTES#

类: SlowBuffer#