Skip to content
An Imbo client library for node.js and modern browsers
JavaScript Other
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
dist Rebuilt browser bundles
docs Add sharpen and contrast to the list of transformations in docs
examples Add user field to browser demo
lib Add `expandGroups`-option to `getAccessControlRules()`
test Add `expandGroups`-option to `getAccessControlRules()`
.coveralls.yml Replaced grunt with gulp
.editorconfig Documentation in place, 2.3.0
.eslintignore
.eslintrc Replaced JSHint with ESLint, update coding standard
.gitignore Add npm-debug to gitignore
.npmignore Replaced grunt with gulp
.travis.yml Trigger readthedocs after successful travis builds
CHANGELOG.md Update changelog
LICENSE Update copyright year
README.md Update badges on README
bower.json Add browser field to package.json
gulpfile.js Replace gulp-rimraf with del, update dependencies
index.js Add browser field to package.json
package.json 3.2.0

README.md

npm versionBuild StatusCoverage StatusDependency status

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.

Documentation

Documentation is available at http://imboclient-js.readthedocs.org/.

More examples

Check out the examples folder for a few intros on how to use the client.

License

Copyright (c) 2011-2015, Espen Hovlandsdal espen@hovlandsdal.com

Licensed under the MIT License

Something went wrong with that request. Please try again.