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

@rapidimages/storage-api-server

v1.3.9

Published

storage api server

Downloads

28

Readme

Storage api js-standard-style build status npm downloads Docker Pulls

Content-addressable storage api for files.

Client and Server for file storage.

Client

const Client = require('@rapidimages/storage-api-client')

Client(url)

url base url to storage api

Returns an instance of client.

methods

client.upload(files, [options])

files in array of either file streams in node, or a file list from a input type file / drag drop.

options.onUploadProgress({ percentage, total, loaded, totalMB, uploadedMB, file })

options.onHashProgress({ file, total, loaded, percentage})

options.onRequest(request)

options.onUnknown(unknown) contains object of files that will be uploaded to api

Usage

const manifestKey = await Client('url').upload([files])
// a hash to the manifest of this upload containing all file keys

All files are hashed using sha1 both in the browser and node.

Each upload will create a manifest in the following format

{
  "files": [
    {
      "size": 697,
      "name": "filepath",
      "key": "0d5061684f1d3c8262bfdefe5c373131a6358aba"
    }
  ]
}

All files including the manifest are served using http /get/key

Browser / Node

The client is available for both node and the browser.

Upload

Files that are known by the server will not be uploaded again :) this is thanks to sha1 hashing.

Usage

STORAGE_PATH=x LOG_PRETTY=1 PORT=5000 npm start

http get /get/key.type

.type is optional will either return content or 404 if not found.

http post /get/unknown

body contains an array of hashes

Will return an array of unknown hashes.

http post multipart /get/upload

Will return a string which will be the sha1 hash of the manifest.

Running Server in docker

ᐅ docker pull rapidimages/storage-api:version
ᐅ docker run --rm --name storage-api -p 5000:5000 rapidimages/storage-api:version

This is the recommended way of running the server behind a reverse proxy like traefik.

license

Apache License, Version 2.0