node package manager
Easy sharing. Manage teams and permissions with one click. Create a free org »

smartimage

node-smartimage

A JavaScript client for Smartimage. Works in node and in the browser!

(Note: It technically works in the browser only if you turn off CORS or use a proxy like corsproxy to bypass CORS restrictions for now.)

License

BuildStatus

Documentation


Quickstart

Just set your options up like below including the username and password. Currently only basic authentication is supported by Smartimage's API.

All API methods are documented at Apiary. All API methods are supported except for file uploads (which are planned for a future release).

var smartimage = require('./index');
 
var options = {
    protocol: 'https',
    host: 'my.smartimage.com',
    auth: {
        type: 'basic',
        username: process.env.SI_USERNAME,
        password: process.env.SI_PASSWORD
    }
};
 
smartimage('GET', '/collections', query, options, function(err, res){
        console.log(res);
});

Asynchronous Response Handling

Promises

Responses can be handled using promises thanks to then/promise.

// Promise
var success = function(res) {
    console.log("Promise success!");
};
 
var failure = function(err){
    console.log("Promise fail!");
}
 
var query = null;
smartimage('GET', '/collections', query, options).then(success, failure);

Callbacks

Responses can also be handled using nodejs style callbacks:

// Callback
var cb = function(err, res){
    console.log("Callback success!");
};
 
var query = null;
smartimage('GET', '/collections', query, options, cb);

Types of Results

The library can also return the response body in different ways. You can use any of the following with callbacks or promises as well.

Receive a Stream of Data

By default, the response object passed into a successful promise or callback is an instance of an http.IncomingMessage and, as such, the response body is a stream.Readable.

smartimage('GET', '/collections', null, options, cb);

Receive a Buffer of Data

You can also receive a Buffer of response data using the buffer() method.

smartimage.buffer('GET', '/collections', null, options, cb);

Receive JSON Data

JSON data can be returned using the json() method:

// JSON Callback
var cb = function(err, res){
    console.log(res.body)
};
 
var query = null;
smartimage.json('GET', '/collections', query, options, cb);
// JSON Promise
var success = function(res) {
    console.log(res.body);
};
 
var query = null;
smartimage.json('GET', '/collections', query, options).then(success);