shardjs

About

A tiny NPM package for splitting and recombining data.

Installation

npm i shardjs

Usage

Importing

import { shardify, blobify } from 'shardjs'

There are two methods in this package to split and recombine data.

Splitting

function shardify(blob, chunk, sizeMode = "MODE_BITSIZE", contentType = "text/plain")

Combining

function blobify(shards, contentType = "text/plain")

Examples

To split a data blob of plaintext into three equal parts.

If there is an additional data that cannot be divided equally, it will be added as a 4th item.

import { shardify } from 'shardjs'

const file = new File(['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j'], 'example.txt')

var shards = shardify(file, 3, "MODE_DIVIDE", "text/plain")

To split a data blob of plaintext into N parts, where each part is 5000 bits.

import { shardify } from 'shardjs'

const file = new File(['0'.repeat(1000000)], 'example.txt')

var shards = shardify(file, 5000, "MODE_BITSIZE", "text/plain")

To recombine blobs of split plaintext data.

import { blobify } from 'shardjs'

const file = new File(['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j'], 'example.txt')
var shards = shardify(file, 3, "MODE_DIVIDE", "text/plain")

var blob = blobify(shards, "text/plain")