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.
All new releases will be published there. This version will not be updated.
import {
asyncDecodeSLIP,
decodeSLIP,
encodeSLIP,
} from "https://deno.land/x/slip_ts/slip.ts";npm install slip-ts or yarn add slip-ts
slip-ts should also work in browser, not tested. Install ist using npm, yarn
or copy slip.ts or build/slip.js
import { encodeSLIP } from "slip-ts";
const data: Uint8Array = ...;
const encoded: Uint8Array = encodeSLIP(data);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
}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);
});Feel free to create an issue to report a bug, contribute fixes, more unit tests or performance improvements!
(c) 2023 Hans Schallmoser
licensed under the GNU Lesser General Public License v2.1 (see LICENSE file)