Module "buffer"
Index
Variables
Variables
BuffType
Type declaration
-
constructor: function
-
Allocates a new buffer containing the given {str}.
Parameters
-
str: string
String to store in buffer.
-
Optional encoding: string
encoding to use, optional. Default is 'utf8'
Returns Buffer
-
-
Allocates a new buffer of {size} octets.
Parameters
-
size: number
count of octets to allocate.
Returns Buffer
-
-
Allocates a new buffer containing the given {array} of octets.
Parameters
-
array: Uint8Array
The octets to store.
Returns Buffer
-
-
Produces a Buffer backed by the same allocated memory as the given {ArrayBuffer}.
Parameters
-
arrayBuffer: ArrayBuffer
The ArrayBuffer with which to share memory.
Returns Buffer
-
-
Allocates a new buffer containing the given {array} of octets.
Parameters
-
array: any[]
The octets to store.
Returns Buffer
-
-
Copies the passed {buffer} data onto a new {Buffer} instance.
Parameters
-
buffer: Buffer
The buffer to copy.
Returns Buffer
-
-
-
prototype: Buffer
-
alloc: function
-
Allocates a new buffer of {size} octets.
Parameters
-
size: number
count of octets to allocate.
-
Optional fill: string | Buffer | number
if specified, buffer will be initialized by calling buf.fill(fill). If parameter is omitted, buffer will be filled with zeros.
-
Optional encoding: string
encoding used for call to buf.fill while initalizing
Returns Buffer
-
-
-
alloc
Unsafe: function -
Allocates a new buffer of {size} octets, leaving memory not initialized, so the contents of the newly created Buffer are unknown and may contain sensitive data.
Parameters
-
size: number
count of octets to allocate
Returns Buffer
-
-
-
alloc
Unsafe Slow: function -
Allocates a new non-pooled buffer of {size} octets, leaving memory not initialized, so the contents of the newly created Buffer are unknown and may contain sensitive data.
Parameters
-
size: number
count of octets to allocate
Returns Buffer
-
-
-
byte
Length: function -
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.
Parameters
-
string: string
string to test.
-
Optional encoding: string
encoding used to evaluate (defaults to 'utf8')
Returns number
-
-
-
compare: function
-
concat: function
-
Returns a buffer which is the result of concatenating all the buffers in the list together.
If the list has no items, or if the totalLength is 0, then it returns a 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.
Parameters
-
list: Buffer[]
An array of Buffer objects to concatenate
-
Optional totalLength: number
Total length of the buffers when concatenated. 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.
Returns Buffer
-
-
-
from: function
-
Allocates a new Buffer using an {array} of octets.
Parameters
-
array: any[]
Returns Buffer
-
-
When passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share the same allocated memory as the TypedArray. The optional {byteOffset} and {length} arguments specify a memory range within the {arrayBuffer} that will be shared by the Buffer.
Parameters
-
arrayBuffer: ArrayBuffer
The .buffer property of a TypedArray or a new ArrayBuffer()
-
Optional byteOffset: number
-
Optional length: number
Returns Buffer
-
-
Copies the passed {buffer} data onto a new Buffer instance.
Parameters
-
buffer: Buffer
Returns Buffer
-
-
Creates a new Buffer containing the given JavaScript string {str}. If provided, the {encoding} parameter identifies the character encoding. If not provided, {encoding} defaults to 'utf8'.
Parameters
-
str: string
-
Optional encoding: string
Returns Buffer
-
-
-
is
Buffer: function -
Returns true if {obj} is a Buffer
Parameters
-
obj: any
object to test.
Returns boolean
-
-
-
is
Encoding: function -
Returns true if {encoding} is a valid encoding argument. Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'
Parameters
-
encoding: string
string to test.
Returns boolean
-
-
INSPECT_MAX_BYTES
SlowBuffType
Type declaration
-
constructor: function
-
prototype: Buffer
-
byte
Length: function -
Parameters
-
string: string
-
Optional encoding: string
Returns number
-
-
-
concat: function
-
is
Buffer: function -
Parameters
-
obj: any
Returns boolean
-
-
Generated using TypeDoc
* MODULES * *