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

imagecachejs

v0.4.0

Published

<img src="https://raw.githubusercontent.com/mahaplatform/imagecachejs/master/docs/logo.png" title="Imagecache" alt="Imagecache" />

Downloads

18

Readme

Express middleware for transforming images and caching them for quick retrieval

Get started

Install with npm or yarn:

npm install --save imagecachejs

You can then use imagecache in your project. The constructor imagecache() will return an express router which you can mount as a subpath for your express app

import express from 'express'
import imagecache from 'imagecachejs'

const app = express()

app.use(express.static('./public'))

app.use('/imagecache', imagecache({
  webRoot: 'public',
  sources: [
    'public',
    'http://localhost:8080'
  ]
}))

app.listen(8080, function () {
  console.log('Example app listening on port 8080')
})

Examples

You can view our example app with the following commands:

# checkout the repository
git clone https://github.com/mahaplatform/imagecachejs.git

# change directory
cd imagecachejs/examples

# install dependencies
npm install

# build the source
npm run build

# start the server
npm run start

Generating an Image

Once your server is up and running, you can invoke an image transformation using the following syntax:

# http://{hostname}/{mountPoint}/{transformationString}/{imagePath}
http://example.com/imagecache/bri=50&sat=30/images/kitten.png

By putting all of the image transformations in the url file path rather than a query string, the transformed file can easily be saved to filesystem and served as a static asset from static middleware (express.static), a web server (nginx, Apache), a content delivery network (Amazon CloudFront, Akamai), or a caching web proxy (Varnish, Squid).

Transformation Strings

Image transformations are invoked using a 'query string like' syntax. For example, if you want to brighten an image, decrease the contrast, and resize the image to a width of 250 pixels, the transformation string would be:

bri=15&con=-10&w=250

These transformations, however, will not necessarily be executed in the order given. If the sequence is important to you, use the op argument:

op[0][bri]=15&op[1][con]=-10&op[2][w]=250

Transformations

The following transformations are available through Imagecache:

  • Brightness (bri)
  • Contrast (con)
  • Hue (hue)
  • Saturation (sat)
  • Tint (tint)
  • Invert (invert)
  • Blur (blur)
  • Flip (flip)
  • Rotate (rot)
  • Padding (pad)
  • Border (border)
  • Crop (crop)
  • Resize (fit,w,h)

Brightness

Increase or decrease the brightness of an image

Contrast

Increase or decrease the contrast of an image

Hue

Rotate the hue of an image with a value between -360 and 360 degrees

Saturation

Increase or decrease the saturation of an image with an amount between -100% and 100%

Tint

Tint an image with a layer of any color with a opacity value between 1% and 100%

Invert

Invert the colors of the image

Blur

Blur image with a radius

Flip

Flip the image horizontally, vertically, or both

Rotate

Rotate image and then crop to largest possible rectangle with same aspect ratio

Padding

Put x pixels of padding around the image

Border

Draw an x pixel thick border around the image

Crop

Crop the image using a reactangle in the format "x,y,w,h"

Resize

Resize the image

Author & Credits

Imagecache was originally written by Greg Kops and is based upon his work with Think Topography and The Cornell Cooperative Extension of Tompkins County.

Special thanks to Oliver Moran and the Jimp project for building the engine that makes Imagecache possible!