6px

Node.js module for 6px

Node.js module for interacting with the 6px API. This module includes methods that makes sending image processing jobs to 6px easier.

Getting Started

Install the NPM package:

$ npm install 6px

##Examples If you want to simply upload an image to the 6px CDN:

var px = require('6px')({
    userId: '***USER_ID***',
    apiKey: '***API_KEY***',
    apiSecret: '***API_SECRET***'
});

var image = px({taxi: 'https://s3.amazonaws.com/ooomf-com-files/mtNrf7oxS4uSxTzMBWfQ_DSC_0043.jpg'});
var output = image.output({ taxi: 'unsplashed_taxi' }).tag('img').url('6px');

image.save(function(err, res) {
    console.log(res);
});

Note: When that callback on the save object is fired, it is only the API's acknowledgment that it received the request.

Given that vintage photos are kind of kind of popular right now, let's take this up a notch:

var px = require('6px')({
    userId: '***USER_ID***',
    apiKey: '***API_KEY***',
    apiSecret: '***API_SECRET***'
});

var image = px({taxi: 'https://s3.amazonaws.com/ooomf-com-files/mtNrf7oxS4uSxTzMBWfQ_DSC_0043.jpg'});
var output = image.output({ taxi: 'unsplashed_taxi' })
    .tag('vintage')
    .url('6px')
    .filter({ sepia: 70 });

image.save(function(err, res) {
    console.log('processing');
});

So, we have a bit of an extreme sepia effect going on here, but that's fine. I think this deserves to be more of a thumbnail. We are going to resize it now:

var px = require('6px')({
    userId: '***USER_ID***',
    apiKey: '***API_KEY***',
    apiSecret: '***API_SECRET***'
});

var image = px({taxi: 'https://s3.amazonaws.com/ooomf-com-files/mtNrf7oxS4uSxTzMBWfQ_DSC_0043.jpg'});
var output = image.output({ taxi: 'unsplashed_taxi' })
    .tag('vintage_thumb')
    .url('6px')
    .filter({ sepia: 70 })
    .resize({ width: 75 });

image.save(function(err, res) {
    console.log('processing');
});

Another thing we can do is change the dominate color of an image:

var px = require('6px')({
    userId: '***USER_ID***',
    apiKey: '***API_KEY***',
    apiSecret: '***API_SECRET***'
});

var image = px({taxi: 'https://s3.amazonaws.com/ooomf-com-files/mtNrf7oxS4uSxTzMBWfQ_DSC_0043.jpg'});
var output = image.output({ taxi: 'unsplashed_taxi' })
    .tag('green')
    .url('6px')
    .filter({ colorize: { hex: '#00FF00', strength: 80 } });

image.save(function(err, res) {
    console.log('processing');
});

Let's blur the image at the same time.

var px = require('6px')({
    userId: '***USER_ID***',
    apiKey: '***API_KEY***',
    apiSecret: '***API_SECRET***'
});

var image = px({taxi: 'https://s3.amazonaws.com/ooomf-com-files/mtNrf7oxS4uSxTzMBWfQ_DSC_0043.jpg'});
var output = image.output({ taxi: 'unsplashed_taxi' })
    .tag('green_blur')
    .url('6px')
    .filter({
        colorize: { hex: '#00FF00', strength: 80 },
        stackBlur: 20
    });

image.save(function(err, res) {
    console.log('processing');
});

Now that we have covered some of the simple use cases, feel free to refer to our documentation!

##API Documentation

Keep us posted on the cool stuff you are doing by sending us an email at [e-mail]. We are constantly trying to improve the user experience. If you come across any issues or have suggestions please create an issue ticket.