Interface Buffer

Hierarchy

Buffer

Index

Constructors

constructor

Methods

Constructors

constructor

new Buffer(size: Number, encoding?: String): WAKBufferInstance

- Defined in buffer.d.ts:3
Creates a new buffer.
```
var myBufferInstance = new Buffer( 16*1024 );
var myBufferInstance = new Buffer( 16*1024, 'utf8' );
```
Parameters
- size: Number
  
  The number of bytes to allocate for the buffer
- Optional encoding: String
  
  (default: utf8) Encoding available: ascii, utf8, ucs2, hex, base64
Returns WAKBufferInstance

Methods

byteLength

byteLength(str: String, encoding?: String): Number

- Defined in buffer.d.ts:29
Returns the string byte length. Byte length may change depending of the encoding type.
```
var myByteLength = Buffer.byteLength( 'Hello Buffer World !' );
console.log(myByteLength);
// 20
```
Parameters
- str: String
  
  String to evaluate
- Optional encoding: String
  
  (default: utf8) Encoding available: ascii, utf8, ucs2, hex, base64
Returns Number

isBuffer

isBuffer(obj: any): Boolean

Checks if the object is a buffer.

Example 1: Is my string a buffer ?

var isBuffer = Buffer.isBuffer( 'Hello Buffer World !' );
console.log( isBuffer );
// false

Example 2: Is my blob a buffer ?

var myBlob = new Blob();
var isBuffer = Buffer.isBuffer( myBlob );
console.log( isBuffer );
// false

Example 3: Is my buffer a buffer ?

var myBuffer = new Buffer( '20' );
var isBuffer = Buffer.isBuffer( myBuffer );
console.log( isBuffer );
// true

Parameters

obj: any

Object to evaluate

Returns Boolean

Returns true is the object is a buffer, false otherwise