@image4io/image4ionodejssdk NPM

altText altText altText

Image4ioNodeSDK

image4io is a full stack image manager that stores, optimizes and delivers for websites and mobile applications. This is the Nodejs SDK for image4io API.

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 16 requests.

GetSubscription
GetImage
UploadImage
FetchImage
CopyImage
MoveImage
DeleteImage
CreateFolder
DeleteFolder
ListFolder
StartUploadStream
UploadStreamPart
FinalizeStream
GetStream
FetchStream
DeleteStream

Documentation is available at: image4io API Documentation

Usage

Default Usage

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

var getRes = api.GetImage(new Models.GetImageRequest("/folderName/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;
        })
    })

Requirements

1) mocha, chai and request-promise npm packages. 2) createReadStream from fs module. 3) Valid Image4io account.

Contact Us

Image4io team is always ready to support you, feel free to contact us.

Contribute

1) You can build the library with npm run build 2) For testing purposes, import your local library run npm install --save ..\image4ionodeSDK\ and you can use it. 3) To contribute, please contact to us with PR or issues or email info@image4.io