README.md

Librarian

An express module responsible for managing dynamic file uploads and downloads:

Installation

npm install librarian

Features

• Easy file uploading
• Lazy file resizing

Usage

Basic file server

var librarian = require('librarian')
var app = librarian()
app.listen( 8888 )

Using in a larger site

var express = require('express')
var librarian = require('librarian')
var app = express()
// all my custom routes
app.use('/files', librarian({options}))
app.listen(8888)

Options

Librarian takes an options object that may contain any of the following keys:

maxSize

The largest the longest side of images can be. If a max size is supplied, images will be resized before storing the original image. The original upload will be lost.

cors

The cors value will be passed directly into the express cors middleware. If you leave this option out, cors will not be used.

storage

A storage plugin is used to store the binary image data.

• ✔ In Memory (default)
• ✔ Amazon S3
• ✔ File System
• ✔ MySQL
• ✘ Google Cloud (Help Develop)

data

A data plugin is used to store file metadata. This includes things like size, filename, and mimetype.

• ✔ In Memory (default)
• ✔ MySQL
• ✔ File System
• ✘ PostreSQL (Help Develop)
• ✘ MongoDB (Help Develop)

cache

A cache plugin is used to cache data fetched from the storage plugin.

• ✔ none (default)
• ✔ In Memory
• ✘ Redis (Help Develop)
• ✘ File System (Help Develop)

Storage and Metadata Plugins

Librarian accepts plugins for storage, caching, and file data. By default, librarian uses in memory implementations of all of these. You can probably get away with using the in memory cache for small setups, but DO NOT use the in memory storage/data plugins in production.

Endpoints

POST /

Returns

{
  id: 'e10a0a08-1688-4dff-8a26-fea6ff32e2d4',
  size: 125731,
  name: 'ducks.jpeg',
  mimeType: 'image/jpeg'
}

GET /:id

Get the image. Query params of height, width, and max can be supplied.

If max is provided, width and height will be ignored.

If both height and width are provided, the aspect ratio of the image will be maintained. The output image will fit completely within the height and width defined.

max, height, and width can all be integers or one of the "presets".

Presets

Name	Value
icon	64
thumbnail	128
small	256
medium	512
large	1024
huge	2048

GET /:id/info

Response

{
  id: 'e10a0a08-1688-4dff-8a26-fea6ff32e2d4',
  size: 125731,
  name: 'ducks.jpeg',
  mimeType: 'image/jpeg'
}