packetgram

packetgram

packet + datagram

Install

npm install packetgram

or

yarn add packetgram

Quick Start

Creating a Packet

import Packet from 'packetgram';

// Allocate a new packet with a specific size
const packet = Packet.alloc(10);

// Or create from an existing ArrayBuffer
const buffer = new ArrayBuffer(10);
const packet = Packet.from(buffer);

Writing Data

const packet = Packet.alloc(20);

// Write various data types (big-endian by default)
packet.writeUInt32(42);
packet.writeString('Hello');
packet.writeFloat(3.14);

// Or use append methods that automatically grow the buffer
const dynamicPacket = new Packet(5);
dynamicPacket.appendUInt32(100);
dynamicPacket.appendString(' World!');

Reading Data

const packet = Packet.alloc(20);
packet.writeUInt32(42);
packet.writeString('Hello');

// Reset offset to read from the beginning
packet.offset = 0;

const number = packet.readUInt32();  // 42
const text = packet.readString(5);   // 'Hello'

Encoding/Decoding

const packet = Packet.alloc(10);
packet.writeString('Hello');

// Encode to base64
const encoded = Packet.encode(packet);

// Decode from base64
const decoded = Packet.decode(encoded);

Endianness

const packet = Packet.alloc(20);

// Default is big-endian (BE)
packet.writeUInt16(42);
packet.writeUInt32(420);

// Switch to little-endian
packet.useEndianness('LE');
packet.writeUInt16(42);
packet.writeUInt32(420);

// Switch back to big-endian
packet.useEndianness('BE');

Dumping Packet Contents

const packet = Packet.alloc(20);
packet.writeUInt16(42);
packet.writeUInt32(420);
packet.writeString('hello');

// Get a hex dump of the packet
console.log(packet.toString());
// Output:
// 00000000  00 2a 00 00 01 a4 68 65  6c 6c 6f 00 00 00 00 00  | .*....hello..... |
// 00000010  00 00 00 00                                       | ....             |