https://github.com/arlac77/length-prefix-framed-stream

Socket framing with length prefixes
https://github.com/arlac77/length-prefix-framed-stream

Last synced: about 1 year ago
JSON representation

Socket framing with length prefixes

• Host: GitHub
• URL: https://github.com/arlac77/length-prefix-framed-stream
• Owner: arlac77
• License: 0bsd
• Created: 2020-07-30T09:42:17.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2025-03-17T13:02:49.000Z (about 1 year ago)
• Last Synced: 2025-03-29T01:03:07.064Z (about 1 year ago)
• Language: JavaScript
• Size: 1.45 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![npm](https://img.shields.io/npm/v/length-prefix-framed-stream.svg)](https://www.npmjs.com/package/length-prefix-framed-stream)

[![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)

[![bundlejs](https://deno.bundlejs.com/?q=length-prefix-framed-stream\&badge=detailed)](https://bundlejs.com/?q=length-prefix-framed-stream)

[![downloads](http://img.shields.io/npm/dm/length-prefix-framed-stream.svg?style=flat-square)](https://npmjs.org/package/length-prefix-framed-stream)

[![GitHub Issues](https://img.shields.io/github/issues/arlac77/length-prefix-framed-stream.svg?style=flat-square)](https://github.com/arlac77/length-prefix-framed-stream/issues)

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Flength-prefix-framed-stream%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/length-prefix-framed-stream/goto)

[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/length-prefix-framed-stream/badge.svg)](https://snyk.io/test/github/arlac77/length-prefix-framed-stream)

[![Coverage Status](https://coveralls.io/repos/arlac77/length-prefix-framed-stream/badge.svg)](https://coveralls.io/github/arlac77/length-prefix-framed-stream)

# length-prefix-framed-stream

Stream framing with length prefixes

```js

import { pipeline } from "stream";

import { Encode } from "length-prefix-framed-stream";

const encode = new Encode();

pipeline(encode, aSendStream, e => {});

encode.write("message 1");

encode.write("message 2");

```

```js

import { pipeline } from "stream";

import { Decode } from "length-prefix-framed-stream";

const decode = new Decode({ objectMode: true, encoding: "utf8" });

pipeline(aReceiveStream, decode, e => {});

for await (const message of decode) {

    console.log(message); // whole messages as put in above

}

```

# API

## Table of Contents

# install

With [npm](http://npmjs.org) do:

```shell

npm install length-prefix-framed-stream

```

# license

BSD-2-Clause