npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

clever-buffer

v4.0.0

Published

Buffer utilities

Downloads

70

Readme

clever-buffer

NPM License

Build Status Dependencies Dev dependencies

Buffer write and read utilities.

CleverBuffer adds functionality that is missing from the node Buffer class

  • Keeps track of the offset for you
  • One time specification of endian-ness and whether to assert on buffer length
  • 64 bit integer support. We use ref under the hood for our 64 bit numbers

Installation

npm install clever-buffer

NOTE: Examples below in javascript

Reader Usage

Requiring the reader in your project

{ CleverBufferReader } = require('clever-buffer');

new CleverBufferReader existingBuffer, [options]

  • existingBuffer Buffer
  • options
    • offset Number, Optional, Default: 0
    • noAssert Boolean, Optional, Default: true
    • bigEndian Boolean, Optional, Default: false

Allocates a new CleverBufferReader with an internal buffer of the specified existingBuffer

var reader = new CleverBufferReader(existingBuffer, { offset: 0, noAssert: true, bigEndian: false});

reader.getUInt8([offset])

  • offset Number, Optional, Default: current buffer position

Returns an Unsigned 8bit Integer from the current offset

var buf = Buffer.from([0xFF, 0x02]);
var reader = new CleverBufferReader(buf);
console.log(reader.getUInt8()); // 255
console.log(reader.getUInt8()); // 2

reader.getInt8([offset])

  • offset Number, Optional, Default: current buffer position

Returns a Signed 8bit Integer from the current offset

var buf = Buffer.from([0xFF, 0x02]);
var reader = new CleverBufferReader(buf);
console.log(reader.getInt8()); // -1
console.log(reader.getInt8()); // 2

reader.getUInt16([offset])

  • offset Number, Optional, Default: current buffer position

Returns an Unsigned 16bit Integer from the current offset.

var buf = Buffer.from([0xFF, 0xFF, 0x02, 0x00]);
var reader = new CleverBufferReader(buf);
console.log(reader.getUInt16()); // 65535
console.log(reader.getUInt16()); // 2

reader.getInt16([offset])

  • offset Number, Optional, Default: current buffer position

Returns a Signed 16bit Integer from the current offset

var buf = Buffer.from([0xFF, 0xFF, 0x02, 0x00]);
var reader = new CleverBufferReader(buf);
console.log(reader.getInt16()); # -1
console.log(reader.getInt16()); # 2

reader.getUInt32([offset])

  • offset Number, Optional, Default: current buffer position

Returns an Unsigned 32bit Integer from the current offset.

var buf = Buffer.from([0xFF, 0xFF, 0xFF, 0xFF]);
var reader = new CleverBufferReader(buf);
console.log(reader.getUInt32()); // 4294967295

reader.getInt32([offset])

  • offset Number, Optional, Default: current buffer position

Returns a Signed 32bit Integer from the current offset

var buf = Buffer.from([0xFF, 0xFF, 0xFF, 0xFF]);
var reader = new CleverBufferReader(buf);
console.log(reader.getInt32()); // -1

reader.getUInt64([offset])

  • offset Number, Optional, Default: current buffer position

Returns an Unsigned 64bit Integer from the current offset.

The value will be returned as a string

var buf = Buffer.from([0xFF, 0xFF, 0xFF, 0xFF,0xFF, 0xFF, 0xFF, 0xFF]);
var reader = new CleverBufferReader(buf);
console.log(reader.getUInt64()); // "18446744073709551615"

reader.getInt64([offset])

  • offset Number, Optional, Default: current buffer position

Returns a Signed 64bit Integer from the current offset

The value will be returned as a string

var buf = Buffer.from([0xFF, 0xFF, 0xFF, 0xFF,0xFF, 0xFF, 0xFF, 0xFF]);
var reader = new CleverBufferReader(buf);
console.log(reader.getInt64()); // "-1"

reader.getString([options])

  • options Optional
    • length Number, Optional, Default: 0
    • offset Number, Optional, Default: current offset. If an offset is specified the current offset will not be incremented
    • encoding String, Optional, Default: 'utf-8'

Returns utf-8 encoded string of specified length

var buf = Buffer.from([0x48, 0x45, 0x4C, 0x4C, 0x4F]);
var reader = new CleverBufferReader(buf);
console.log(reader.getString(length: 5)); // "HELLO"

Writer Usage

Requiring the writer in your project

{ CleverBufferWriter } = require('clever-buffer');

new CleverBufferWriter existingBuffer, [options]

  • existingBuffer Buffer
  • options
    • offset Number, Optional, Default: 0
    • noAssert Boolean, Optional, Default: true
    • bigEndian Boolean, Optional, Default: false

Allocates a new CleverBufferWriter with an internal buffer of the specified existingBuffer

var writer = new CleverBufferWriter(existingBuffer, {offset: 0, noAssert: true, bigEndian: false});

writer.writeUInt8(value, [offset])

  • value Number
  • offset Number, Optional, Default: current buffer position

Writes an Unsigned 8bit Integer to the specified/current offset

var buf = Buffer.alloc(2);
var writer = new CleverBufferWriter(buf);
writer.writeUInt8(255);
writer.writeUInt8(2);
console.log(buf); // [0xFF, 0x02]

writer.writeInt8(value, [offset])

  • value Number
  • offset Number, Optional, Default: current buffer position

Writes an signed 8bit Integer to the specified/current offset

var buf = Buffer.alloc(2);
var writer = new CleverBufferWriter(buf);
writer.writeInt8(-1);
writer.writeInt8(2);
console.log(buf); // [0xFF, 0x02]

writer.writeUInt16(value, [offset])

  • value Number
  • offset Number, Optional, Default: current buffer position

Writes an Unsigned 16bit Integer to the specified/current offset

var buf = Buffer.alloc(4);
var writer = new CleverBufferWriter(buf);
writer.writeUInt16(65535);
writer.writeUInt16(2);
console.log(buf); // [0xFF, 0xFF, 0x02, 0x00]

writer.writeInt16(value, [offset])

  • value Number
  • offset Number, Optional, Default: current buffer position

Writes an Signed 16bit Integer to the specified/current offset

buf = Buffer.alloc(4);
writer = new CleverBufferWriter(buf);
writer.writeInt16(-1);
writer.writeInt16(2);
console.log(buf); // [0xFF, 0xFF, 0x02, 0x00]

writer.writeUInt32(value, [offset])

  • value Number
  • offset Number, Optional, Default: current buffer position

Writes an Unsigned 32bit Integer to the specified/current offset

var buf = Buffer.alloc(4);
var writer = new CleverBufferWriter(buf);
writer.writeUInt32(4294967295);
console.log(buf); // [0xFF, 0xFF, 0xFF, 0xFF]

writer.writeInt32(value, [offset])

  • value Number
  • offset Number, Optional, Default: current buffer position

Writes an signed 32bit Integer to the specified/current offset

var buf = Buffer.alloc(4);
var writer = new CleverBufferWriter(buf);
writer.writeInt32(-1);
console.log(buf); // [0xFF, 0xFF, 0xFF, 0xFF]

writer.writeString(value, [options])

  • value String
  • options Optional
    • length Number, Optional, number of bytes to write. Note this can be greater than value.length for non ASCII encodings. If not specified, will default to the right number of bytes for the chosen encoding.
    • offset Number, Optional, Default: current offset. If an offset is specified the current offset will not be incremented
    • encoding String, Optional, Default: 'utf-8'
  • returns the number of bytes written

Writes string to the buffer

var buf =  Buffer.alloc(8);
var writer = new CleverBufferWriter(buf);
var len = writer.writeString("héllo");
console.log(len, buf); // 6, [0x68, 0xc3, 0xa9, 0x6c, 0x6c, 0x6f, 0x00, 0x00]

Common Functionality

The following is common to CleverBufferReader and CleverBufferWriter (The examples only show reader)

reader.getOffset()

Gets the current offset of the buffer

var buf = Buffer.from([0xFF, 0x02]);
var reader = new CleverBufferReader(buf);
console.log(reader.getOffset()); // 0
reader.getUInt8();
console.log(reader.getOffset()); // 1
reader.getUInt8();
console.log(reader.getOffset()); // 2  

reader.skip(bytes)

  • bytes Number

Skips the current offset forward the specified bytes amount

var buf = Buffer.from([0xFF, 0x02]);
var reader = new CleverBufferReader(buf);
console.log(reader.getOffset()); // 0
reader.skip(2);
console.log(reader.getOffset()); // 2  

reader.skipTo(offset)

  • offset Number

Skips to the specified offset

var buf = Buffer.from([0xFF, 0xFF, 0xFF, 0x01]);
var reader = new CleverBufferReader(buf);
console.log(reader.getOffset()); // 0
reader.skipTo(3);
console.log(reader.getOffset()); // 3  

reader.getBuffer()

Will return the underlying buffer so you can perform actions directly on it

var buf = Buffer.from([0xFF, 0x02]);
var reader = new CleverBufferReader(buf);
console.log(reader.getBuffer()[1]); // 2

reader.trim()

Will return a buffer slice from the start of the buffer to the current offset

var buf = Buffer.from([0xFF, 0x02]);
var reader = new CleverBufferReader(buf);
reader.getUInt8();
console.log(reader.trim()); // [0xFF]
console.log(buf);           // [0xFF, 0x02]

Testing

npm test