felixbrucker / UInt128

Encode and Decode Int128/UInt128 as a Buffer

Installation

npm install uint128

Usage

const { Int128, UInt128 } = require('uint128');

const encodedUInt128 = UInt128.encodeBE(1000000000000000000000000000000n);
console.log(encodedUInt128, UInt128.decodeBE(encodedUInt128))

const encodedInt128 = Int128.encodeBE(-1000000000000000000000000000000n);
console.log(encodedInt128, Int128.decodeBE(encodedInt128))

Classes

Int128

encodeBE(int) ⇒ Buffer

Encodes a 128 bit integer as Big Endian Buffer.

Param	Type	Description
int	BigInt	Integer to encode

decodeBE(buffer, offset = 0) ⇒ BigInt

Decodes a Big Endian Buffer into a 128 bit integer

Param	Type	Description
buffer	Buffer	Buffer to decode
offset	Integer	Offset to decode at

encodeLE(int) ⇒ Buffer

Encodes a 128 bit integer as Little Endian Buffer.

Param	Type	Description
int	BigInt	Integer to encode

decodeLE(buffer, offset = 0) ⇒ BigInt

Decodes a Little Endian Buffer into a 128 bit integer

Param	Type	Description
buffer	Buffer	Buffer to decode
offset	Integer	Offset to decode at

UInt128

encodeBE(int) ⇒ Buffer

Encodes a 128 bit unsigned integer as Big Endian Buffer.

Param	Type	Description
int	BigInt	Integer to encode

decodeBE(buffer, offset = 0) ⇒ BigInt

Decodes a Big Endian Buffer into a 128 bit unsigned integer

Param	Type	Description
buffer	Buffer	Buffer to decode
offset	Integer	Offset to decode at

encodeLE(int) ⇒ Buffer

Encodes a 128 bit unsigned integer as Little Endian Buffer.

Param	Type	Description
int	BigInt	Integer to encode

decodeLE(buffer, offset = 0) ⇒ BigInt

Decodes a Little Endian Buffer into a 128 bit unsigned integer

Param	Type	Description
buffer	Buffer	Buffer to decode
offset	Integer	Offset to decode at