JavaScript library to generate and sign LibPixel URLs.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
src
test
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
gulpfile.js Initial commit May 29, 2015
package.json

README.md

LibPixel

Build Status

JavaScript library to generate and sign LibPixel URLs.

Install

$ npm install libpixel

Usage

Start by requiring the module and creating an instance of the client.

var LibPixel = require("libpixel");
var libpx = new LibPixel({ host: "test.libpx.com" });

In addition to host, the following options are supported:

  • secret: Auth secret for your LibPixel account. Required for signing requests.
  • https: Generate HTTPS URLs. Default is false.

Sign URLs

You can sign an existing URL using the sign function:

var url = libpx.sign("http://test.libpx.com/images/1.jpg?width=400");

Generate URLs

You can also generate and sign URLs at the same time with the url function:

var url = libpx.url("/images/1.jpg", { height: 400, blur: 20, saturation: -80 });

License

MIT