Skip to content

Repository files navigation

Node Buffer Reader

Make reading data from a binary buffer easily.

Build Status

Install

npm install buffer-reader

Usage

varBufferReader=require('buffer-reader');varreader=newBufferReader(buffer);// Read next N bytes as stringvarstr=reader.nextString(10);// Read next N bytes as buffervarbuf=reader.nextBuffer(10);// Read next 2 bytes as Int16LEvari=reader.nextInt16LE();// Read next 8 bytes as DoubleLEvard=reader.nextDoubleLE();// Get all rest bytes as buffervarrest=reader.restAll();// OutOfBound will raise exceptiontry{reader.nextString(1);}cache(e){// handle exception}// Append buffer to readerreader.append(newbuffer);// Read againreader.nextString(1);

APIs

new BufferReader([buffer])

Create a new reader, if no buffer provided, a empty buffer will be used.

append(buffer)

Append new buffer to the end of current reader

tell()

Return current position of the reader

seek(pos)

Set new position of the reader, if the pos is invalid, an exception will be raised

move(offset)

Move the position of reader by offset, offset can be negative; it can be used to skip some bytes

restAll()

Get all the remaining bytes as a Buffer

nextBuffer(length)

Read a buffer with specified length

nextString(length, [encoding])

Read next length of bytes as String, encoding default is 'utf8'

next(Int8|UInt8)[(Int16|UInt16|Int32|UInt32|Float|Double)(LE|BE)]()

Read next bytes as given types, the value is just as the same format Buffer in nodejs doc.

License

(The BSD License)

Copyright (c) 2013, Villa.Gao jky239@gmail.com; All rights reserved.

About

A Buffer Reader to make reading data from binary buffer easily

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages