yukikaze-bot / erlpack

Erlpack is a fast encoder and decoder for the Erlang Term Format (version 131) for JavaScript.

@yukikaze-bot/erlpack

A encoder and decoder utility.

Table of Contents

• @yukikaze-bot/erlpack
  • Description
  • Features
  • Installation
  • Usage
    • Basic Usage
  • API Documentation

Description

Erlpack is a fast encoder and decoder for the Erlang Term Format (version 131) for JavaScript.

Features

• Written in TypeScript
• Offers CommonJS, ESM bundles
• Fully tested
• Powered by C++

Installation

yarn add @yukikaze-bot/erlpack
# npm install @yukikaze-bot/erlpack
# pnpm add @yukikaze-bot/erlpack

Usage

Note: While this section uses require, the imports match 1:1 with ESM imports. For example const { pack } = require('@yukikaze-bot/erlpack') equals import { pack } from '@yukikaze-bot/erlpack'.

Note: When using ESM syntax you can also default-import pack function: import pack from '@yukikaze-bot/erlpack'.

Basic Usage

const { pack, unpack } = require('@yukikaze-bot/erlpack');
const packed = pack('Hello, World!');

console.log(unpack(packed));

---

API Documentation

For the full API documentation please refer to the TypeDoc generated documentation.