npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

chunkinator

v2.0.5

Published

Upload large files from the browser with ease

Downloads

1,282

Readme

chunkinator

Upload large files from the browser with ease

Pipeline pieces description

See examples/integrator.ts for good example of usage.

import chunkinator from 'chunkinator';

chunkinator is a main customizable high level component that gives you a way to upload large files. It takes a file as an input and pushes it through Observable pipe that consist of the following parts:

  • slicenator
  • hashinator
  • probinator
  • uploadinator
  • processinator

As a second argument chunkinator takes configuration options with following interface:

interface Options {
  chunkSize: number;
  hashingConcurrency: number;
  hashingFunction?: HashingFunction;
  probingBatchSize: number;
  probingFunction: ProbingFunction;
  uploadingConcurrency: number;
  uploadingFunction: UploadingFunction;
  processingBatchSize: number;
  processingFunction?: ProcessingFunction;
}

As a third argument chunkinator takes list of handy callbacks. Currently there is only one: onProgress.

slicenator

This component takes a blob, chunk size and returns Observable sequential stream of blob chunks.

Options' chunkSize is what defines chunk size

hashinator

This component takes stream of blobs and hashes each chunk. Returning stream contains blob and it's hash.

Options' hashingConcurrency defines how many chunks are hashed at the same time. hashingFunction is optional hashing function. If hashingFunction is not provided SHA-1 will be used instead.

probinator

This component takes already hashed blobs and probes each of them with backend for it already being uploaded. Resulting stream contains blob with hash and boolean indicating if it exists on a backend already.

Options' probingFunction is a function that takes batch of hashed blobs and returns list of booleans. probingBatchSize controls how many hashed blobs are given to probing function at a time.

uploadinator

This component takes probed and hashed blobs and uploads them if blob doesn't exists on a backend.

Options' uploadingFunction is a callback that takes a blob and uploads it to the server. uploadingConcurrency controls how many of these calls happens at the same time.

processinator

With this component consumer has an opportunity to finalize already uploaded chunks in some way.

Options' processingFunction defines a function that is called with sequential batches of uploaded chunks. processingBatchSize controls how many uploaded chunks are given to processing function.

onProgress callback

This callback is called with every uploaded chunk. The only argument it is called with a portion of already uploaded chunks to it's total number.