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

load-stream

v1.0.6

Published

A npm package to upload files as chunk

Downloads

9

Readme

Load Stream

npm version License

Description

Load Stream is a versatile package that facilitates the uploading of large files to a server in chunks. The package provides both server-side (load-stream) and client-side (loadstream-client) components. It utilizes HTTP short polling to break files into chunks and send them to the server, providing multiple listeners for events like progress, completion, and errors.

Features

  • Efficient file uploading with chunking
  • HTTP short polling for improved performance
  • Multiple event listeners: onprogress, onload, onerror
  • Methods for stopping and resuming uploads

Installation

Server-Side (load-stream)

Install the package using npm:

npm install load-stream

Integrate it into your server with Express:

const loadStream = require('load-stream');
const express = require('express');
const app = express();

/* cb function to provide and modify the fileName and destination(where to save file)
  this cb function expect an argument which contains file information and current uploading directory.
Example:
  file-> {
    fileName:'hello.png',
    fileSize:1242,
    destination:'/' //default destination
  }
*/
const cb = (file) => {
    return {
        fileName: Date.now() + file.fileName,
        destination: '/public/uploads'
    }
}
//creating instance of loadStream
let loader = new loadStream(cb);

//use this loadStream instance as middleware to handle and make http requests
app.use(loader.load());
//on Error 
loader.onerror = (e) => {
    console.log(e);
}

Client-Side (CDN)

You can include the client-side library via CDN in your HTML file:

<script src="/loadStream/loadStream.js"></script>
<script>
  /*
    options = {
     chunksize: 1024 * 1024, // default 1024*1024 (in bytes)
     method: 'http' or 'websocket' // ['websocket','http'] -> fallback from websocket to http
    }
  */
  let options = {
    chunksize: 1024
  }
  let loader = new LoadStream(options); //options argument is optional fallback to default options

  const uploadFile = (file)=>{
      loader.upload(file);
  }

  loader.onprogress = (event) => {
      console.log(event.progress);// progress Example: to use in progress bar
      console.log(event.time); // Expected time remains in uploading file (in seconds)
      console.log(event.speed);// Uploading speed (in bytes/sec)
  }

  loader.onload = () => {
    console.log("Completed");
  }

  loader.onerror = (event) => {
    console.log(event.error);
  }
  
  const resumeUpload = ()=>{
    loader.resume(); // returns true if resumed else false
  }

  const pauseUpload = ()=>{
    loader.stop();// returns true if paused else false
  }
</script>

Client-Side (loadstream-client)

To include client side script in React.Js/Next.Js etc

npm install loadstream-client

Integrate it into your client side:

import loadStream from 'loadstream-client'
/*
  const url='http://localhost:5000'; // url is server's host url 
*/
let loader = new loadStream({ url }) // url is required*

	const uploadFile = async (file) => {
          try {
                       loader.upload(file);

		       loader.onprogress = (event) => {
		            console.log(event.progress);// progress Example: to use in progress bar
		            console.log(event.time); // Expected time remains in uploading file (in seconds)
		            console.log(event.speed);// Uploading speed (in bytes/sec)
		        }
		      
		        loader.onload = () => {
		          console.log("Completed");
		        }
		      
		        loader.onerror = (event) => {
		          console.log(event.error);
		        }
		        
		        const resumeUpload = ()=>{
		          loader.resume(); // returns true if resumed else false
		        }
		      
		        const pauseUpload = ()=>{
		          loader.stop();// returns true if paused else false
		        }

		} catch (error) {
			console.error("Upload error:", error);
		}

Contributing

We welcome contributions! Your contribution means to us.

License

This project is licensed under the MIT License - see the LICENSE file for details.