Image4ionodejssdk NPM

altText altText altText

Image4ioNodeSDK

image4io is a cloud service where your images are uploaded, moved, copied, fetched, deleted.

Configuration

To send requests to API, APIKey and APISecret must be given as string first. Required keys can be retrieved from image4io console.

import Image4ioAPI = require('./Image4ioAPI');

var apiKey = 'apiKey';
var apiSecret = 'apiSecret';

var api = new Image4ioAPI.Image4ioAPI(apiKey, apiSecret);

Available Requests

This SDK currently supports 9 requests.

GetImageDetails
UploadFiles
Fetch
CopyFile
MoveFile
ListFolder
CreateFolder
DeleteFile
Delete Folder

Documentation is available at: image4io API Documentation

Usage

Default Usage

With Image4io, it is very straightforward to do an operation on your images. GetImageDetail example can be seen below.

var getRes = api.GetImageDetails(new Models.GetImageDetailsRequestModel("/test.png"));
getRes.then(response => {
    //Response returns a JSON object, which can be accessed here
}).catch(error => {
    throw error;
})

Unit Testing

Unit testing could be done by using chai and mocha packages. Complete test can be found in the Test.ts file. Tests are run by npm run tsc then mocha test.js commands.

describe('Image4IOAPITest', () => {
    it('GetTest', () => {
        var getRes = api.GetImageDetails(new Models.GetImageDetailsRequestModel("/test.png"));
        return getRes.then(response => {
            chai.expect(response.name).of.equals("/test.png");
        }).catch(error => {
            throw error;
        })
    })