https://github.com/csimi/chonker

Creates chonks from your chunks
https://github.com/csimi/chonker

Last synced: 8 months ago
JSON representation

Creates chonks from your chunks

• Host: GitHub
• URL: https://github.com/csimi/chonker
• Owner: csimi
• License: isc
• Created: 2022-02-18T13:30:16.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-02-18T14:04:52.000Z (over 4 years ago)
• Last Synced: 2025-10-09T03:57:35.567Z (8 months ago)
• Language: JavaScript
• Size: 32.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

          
[![npm version](https://img.shields.io/npm/v/chonker.svg?logo=npm)](https://www.npmjs.com/package/chonker)

[![build status](https://github.com/csimi/chonker/workflows/build/badge.svg)](https://github.com/csimi/chonker/actions)

[![codecov](https://codecov.io/gh/csimi/chonker/branch/master/graph/badge.svg)](https://codecov.io/gh/csimi/chonker)

# About

Chonks your chunks into complete strings with a configurable separator character.

# Usage

Install using npm:

```

$ npm install chonker

```

## EventChonker

```

const { deepStrictEqual } = require('assert');

const { EventChonker } = require('chonker');

const data = [];

const chonker = new EventChonker('\0');

chonker.on('data', data.push.bind(data));

chonker.write('fo');

chonker.write('o\0bar\0');

deepStrictEqual(data, [

	'foo',

	'bar',

]);

```

## StreamChonker

```

const { deepStrictEqual } = require('assert');

const { PassThrough } = require('stream');

const { StreamChonker } = require('chonker');

const data = [];

const chonker = new StreamChonker('|');

const source = new PassThrough();

source.pipe(chonker);

chonker.on('data', data.push.bind(data));

source.write('fo');

source.write('o|bar|');

deepStrictEqual(data, [

	Buffer.from('foo'),

	Buffer.from('bar'),

]);

```