@phrohdoh/binary-buffer-parser

binary-buffer-parser

A simple binary buffer parser.

Download

binary-buffer-parser is installable via:

• GitHub git clone https://github.com/Pupix/binary-buffer-parser.git
• npm: npm install binary-buffer-parser

Quick example

var BinaryParser = require('binary-buffer-parser'),
    buffer = new Buffer('Hello world!')
    parser = new BinaryParser(buffer);
        
    console.log(parser.int8()); // 72
    console.log(parser.uint32()); // 1869376613
    console.log(parser.stringView().join('')) // Hello World!

---

Methods

####Helper Methods

• endianess
• size
• seek
• skip
• tell

####Generic Methods

• int8 / byte
• uint8 / ubyte
• int16 / short
• uint16 / ushort
• int32 / int
• uint32 / uint
• float
• double / long
• string
• string0

####Bitfield Methods

• bit8
• bit16
• bit32

####View Methods

• stringView
• hexView
• ansiView

---

Documentation

## Helper Methods ### endianess(endian)

Sets the endian format of the parser.

Parameters

1. endian {string} The new endian format. Can be either little/LE for little endian or big/BE for big endian.

### size()

Returns the length of the buffer.

### seek(offset)

Sets the offset of the reading cursor at the passed position, starting from the beginning of the buffer.

1. offset {number} The new value of the new offset position.

### skip(offset)

Advances the reading cursor by the passed offset from its current position.

1. offset {number} The number of bytes to skip over.

### tell()

Returns the position of the reading cursor inside the buffer.

## Generic Methods ### int8(length) / byte(length)

Reads a signed 8 bit integer from the buffer. If length is passed, the same function will be ran multiple times and return the result as an array.

Parameters

1. [length] {number} The number of int8 to read consecutively

### uint8(length) / ubyte(length)

Reads a unsigned 8 bit integer from the buffer. If length is passed, the same function will be ran multiple times and return the result as an array.

Parameters

1. [length] {number} The number of uint8 to read consecutively

### int16(length) / short(length)

Reads a signed 16 bit integer from the buffer. If length is passed, the same function will be ran multiple times and return the result as an array.

Parameters

1. [length] {number} The number of int16 to read consecutively

### uint16(length) / ushort(length)

Reads a unsigned 16 bit integer from the buffer. If length is passed, the same function will be ran multiple times and return the result as an array.

Parameters

1. [length] {number} The number of uint16 to read consecutively

### int32(length) / int(length)

Reads a signed 32 bit integer from the buffer. If length is passed, the same function will be ran multiple times and return the result as an array.

Parameters

1. [length] {number} The number of int32 to read consecutively

### uint32(length) / uint(length)

Reads a unsigned 32 bit integer from the buffer. If length is passed, the same function will be ran multiple times and return the result as an array.

Parameters

1. [length] {number} The number of uint32 to read consecutively

### float(length)

Reads a 32 bit float from the buffer. If length is passed, the same function will be ran multiple times and return the result as an array.

Parameters

1. [length] {number} The number of floats to read consecutively

### double(length) / long(length)

Reads a unsigned 64 bit double from the buffer. If length is passed, the same function will be ran multiple times and return the result as an array.

Parameters

1. [length] {number} The number of doubles to read consecutively

### string(length)

Reads an ASCII string from the buffer.

Parameters

1. length {number} The length of the string.

### string0()

Reads a null terminated ASCII string from the buffer.

## Bitfield methods ### bit8()

Reads an unsigned 8 bit integer from the buffer and returns an array with true/false based on the values of each bit.

### bit16()

Reads an unsigned 16 bit integer from the buffer and returns an array with true/false based on the values of each bit.

### bit32()

Reads an unsigned 32 bit integer from the buffer and returns an array with true/false based on the values of each bit.

## View Methods ### stringView()

Returns the buffer in ASCII encoding inside an array, divided by character.

### hexView()

Returns the buffer in hexadecimal encoding inside an array, divided by byte.

### ansiView()

Returns the buffer in ANSI encoding inside an array, divided by character.