conflux's Introduction

Conflux

Build and read zip files with whatwg streams in the browser.

/ˈkänˌfləks/ (noun) a flowing together of two or more streams

Blazing Fast

21.6 kB import
Uses streams, minimizing memory overhead

Examples

Usage

Importing Conflux

# With Yarn
yarn add @transcend-io/conflux

# With NPM
npm install --save @transcend-io/conflux

import Zip from "@transcend-io/conflux/write";

const { readable, writable } = new Zip();

Writing a ZIP

import Zip from "@transcend-io/conflux/write";
import streamSaver from "streamsaver";

// Set up conflux
const { readable, writable } = new Zip();
const writer = writable.getWriter();

// Set up streamsaver
const fileStream = streamSaver.createWriteStream("conflux.zip");

// Add a file
writer.write({
  name: "/cat.txt",
  lastModified: new Date(0),
  stream: () => new Response("mjau").body
});

readable.pipeTo(fileStream);

writer.close();

Incorporating other streams

(async () => {
  writer.write({
    name: "/cat.txt",
    lastModified: new Date(0),
    stream: () => new Response("mjau").body
  });

  const imgStream = await fetch(
    "https://s3-us-west-2.amazonaws.com/bencmbrook/Earth.jpg"
  ).then(r => r.body);

  writer.write({
    name: "/Earth.jpg",
    lastModified: new Date(0),
    stream: () => imgStream
  });

  readable.pipeTo(fileStream);

  writer.close();
})();

Reading ZIP files

import reader from "@transcend-io/conflux/read";

fetch("https://cdn.jsdelivr.net/gh/Stuk/jszip/test/ref/deflate.zip").then(
  async res => {
    const zip = await res.blob();
    for await (const entry of reader(zip)) {
      console.log(entry);
    }
  }
);