Imboclient NPM

Javascript client for Imbo

A Javascript (node/browser) client for Imbo.

Installation

imboclient-js can be installed using npm or bower:

# NPM:
npm install imboclient

# Bower:
bower install imboclient

Version note

Imbo 2.0 and up prefers imboclient-js >= 3.0.0

Imbo 1.0 and up requires imboclient-js >= 2.1.0

Imbo 0.3.3 and below requires imboclient-js <= 2.0.2

Basic usage

var Imbo = require('imboclient');
var client = new Imbo.Client({
    hosts: 'http://<hostname>',
    user: '<someUser>',
    publicKey: '<publicKey>',
    privateKey: '<privateKey>'
});

client.addImage('/path/to/image.jpg', function(err, imageIdentifier) {
    if (err) {
        return console.error('Oh no, an error occured: ' + err);
    }

    console.log('Image added! Image identifier: ' + imageIdentifier);

    // Grab a transformed URL
    var url = client.getImageUrl(imageIdentifier)
        .maxSize({ 'width': 320 })
        .sepia()
        .border({ 'color': 'BF1942', 'width': 4 });

    console.log('URL to transformed image: ' + url.toString());

    // Edit the metadata of the image
    client.editMetadata(imageIdentifier, {
        'title': 'Cat in the sun',
        'description': 'A cat relaxing in Santorini, Greece'
    });
});

See the documentation for more details on how to use the client.