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

s3-thumb-server

v2.3.5

Published

Serve thumbnails of images stored on S3 over HTTP

Downloads

2

Readme

s3-thumb-server Travis npm package

s3-thumb-server is an HTTP server that serves thumbnails of images stored on S3.

Installation

Using npm:

$ npm install --save s3-thumb-server

Then, use as you would anything else:

// using ES6 modules
import { createServer } from 's3-thumb-server'

// using CommonJS modules
var createServer = require('s3-thumb-server').createServer

Configuration and Usage

Use createServer to create a server instance, passing it all the information it needs to connect to S3:

import { createServer } from 's3-thumb-server'

const server = createServer({
  accessKeyId: '...',         // Your AWS access key ID, required
  secretAccessKey: '...',     // Your AWS secret access key, required
  region: 'us-west-1',        // The AWS region of your S3 bucket, defaults to "us-west-1"
  s3Bucket: '...'             // The name of your S3 bucket, required
})

server.listen(8080)

server is a standard node HTTP server.

If you'd like to use s3-thumb-server as part of a larger site, using e.g. a framework like express, you can use the createRequestHandler function directly. As its name suggests, this function returns another function that can be used as the request handler in a standard node HTTP server. This function accepts the same options as createServer.

import express from 'express'
import { createRequestHandler } from 's3-thumb-server'

const app = express()
app.use(express.static('public'))
app.use(createRequestHandler())

// ...

URL Format

In s3-thumb-server, the URL is the API. The server recognizes URLs in the format /size/key where:

size            A string in the format WxH, e.g. 120x100
key             The key of the image in S3

You may omit either the width or the height to constrain the resize operation by only one dimension. For example, 200x will constrain the width to 200 pixels and automatically calculate the height preserving the aspect ratio of the original. Likewise, x200 will constrain by height.

Signing URLs

The server has the ability to automatically reject requests that have not been signed using a cryptographically secure key. To use this feature, pass a secretKey option to createServer:

import { createServer } from 's3-thumb-server'

const server = createServer({
  // ...
  secretKey: 'something secret'
})

This server will recognize URLs like /signature/size/key, where signature is a signed value that may be generated using the secret key and the S3 key for a given object.

import { generateSignature } from 's3-thumb-server'
const signature = generateSignature(secretKey, key)