slip-ts

Typescript (and JavaScript) SLIP encoder/decoder

SLIP: https://en.wikipedia.org/wiki/Serial_Line_Internet_Protocol

Inspired by https://github.com/colinbdclark/slip.js, rewritten in TypeScript and enhanced to support AsyncIterators.

Starting with version 1.1.0 a newer and faster implementation is used.

Installation

Deno

import {
  asyncDecodeSLIP,
  decodeSLIP,
  encodeSLIP,
} from "https://deno.land/x/slip_ts/slip.ts";

Node.js

npm install slip-ts or yarn add slip-ts

Web

slip-ts should also work in browser, not tested. Install ist using npm, yarn or copy slip.ts or build/slip.js

Usage

Encoding

import { encodeSLIP } from "slip-ts";

const data: Uint8Array = ...;

const encoded: Uint8Array = encodeSLIP(data);

Decoding Option 1 - Preferred - using AsyncIterators

import { asyncDecodeSLIP } from "slip-ts";

const input: AsyncIterable<Uint8Array> = ...;

for await (const decoded: Uint8Array of asyncDecodeSLIP(input)) {
    // decoded is a Uint8Array containing a decoded data frame
}

Decoding Option 2 - Classic - using callbacks

import { decodeSLIP } from "slip-ts";

const decoder = decodeSLIP((decoded: Uint8Array) => {
  // decoded is a Uint8Array containing a decoded data frame
});

yourDataSource.on("data", (data: UInt8array) => {
  decoder(data);
});

Contributing

Feel free to create an issue to report a bug, contribute fixes, more unit tests or performance improvements!

License

licensed under the GNU Lesser General Public License v2.1 (see LICENSE file)