Aspose.Imaging Cloud Node.js SDK
Aspose.Imaging Cloud is a true REST API that enables you to perform a wide range of image processing operations including creation, manipulation and conversion in the cloud, with zero initial costs. Our Cloud SDKs are wrappers around REST API in various programming languages, allowing you to process images in language of your choice quickly and easily, gaining all benefits of strong types and IDE highlights.
This repository contains Aspose.Imaging Cloud Node.js SDK source code which is written in TypeScript. This SDK allows you to work with Aspose.Imaging Cloud REST APIs in your Node.js applications quickly and easily, with zero initial cost.
To use this SDK, you will need App SID and App Key which can be looked up at Aspose Cloud Dashboard (free registration in Aspose Cloud is required for this).
Key Features
Image Formats Support
Export the following images to various formats (generally supported ones are BMP, PSD, JPEG, TIFF, GIF, PNG, JPEG2000, WEBP and PDF):
- BMP
- GIF
- DJVU
- WMF
- EMF
- JPEG
- JPEG2000
- PSD
- TIFF
- WEBP
- PNG
- DICOM
- CDR
- ODG
- OTG
- DNG
- SVG
- CMX
Process options, change and return images in the same format:
- PSD
- JPEG
- TIFF
- GIF
- BMP
- JPEG2000
- WEBP
Process options, change and return images in any supported export format:
- EMF
- WMF
Supported Imaging Operations
- Export
- Resize
- Crop
- Rotate and Flip
- TIFF frames extraction
- TIFF frames manipulation
- TIFF concatenation
- TIFF conversion to fax-friendly format
- Retrieve & update image properties
- Conversion to and from PSD format
Supported Imaging AI Operations
- Content-based image search
- Image duplicates search
- Image search by custom registered tags
- Image comparison and similarity detection
- Image features extraction (for now, AKAZE detector is supported)
For the complete list of use-cases, please refer to the format support document to see what you can achieve!
Storage API support
Since version 19.4, SDK includes support of storage operations for better user experience and unification, so now there's no need to use 2 different SDKs!
It gives you an ability to:
- Upload, download, copy, move and delete files, including versions handling (if you are using Cloud storage that supports this feature - true by default)
- Create, copy, move and delete folders
- Copy and move files and folders accross separate storages in scope of a single operation
- Check if certain file, folder or storage exists
Detalied official documentation can be found at the following link.
Getting Started
- Sign Up. Before you begin, you need to sign up for an account on our Dashboard and retrieve your credentials.
- Minimum requirements. This SDK requires Node.js 6.x and higher.
- Install Aspose.Imaging Cloud Node.js SDK.
Please, add the following nmp package to your project.json as a dependency.
{
"dependencies": {
"@asposecloud/asposeimagingcloud": "^19.12.0"
}
}Import the dependencies to your code as follows.
import * as imaging from "@asposecloud/asposeimagingcloud";- Using the SDK. The best way to become familiar with how to use the SDK is to read the Developer Guide. The Getting Started Guide will help you to become familiar with the common concepts.
Quick Examples
Please, look at Examples document.
Aspose Cloud-hosted service VS on-premise deployment (experimental feature)
Starting from v19.7, you can choose either to use Aspose Cloud-hosted image processing service (the standard way) or the Docker image from Docker Hub deployed on-premise to serve the requests. The details about key differences and deployment process will be described on the dedicated Docker Hub page as soon as it's released.
To succeed with your on-premise service usage by the SDK, you need to:
- Set the appKey and appSID parameters as null and use baseUrl parameter according to your on-premise deployment with additional API version and debug mode parameters.
const imagingApi: imaging.ImagingApi = new imaging.ImagingApi(null, null, "yourServiceUrl");- Set storage or storageName parameters for each request where they're present (mandatory!).
Dependencies
Licensing
All Aspose.Imaging Cloud SDKs, helper scripts and templates are licensed under MIT License.
Contact Us
Your feedback is very important to us. Please feel free to contact via
Resources
Other languages
We generate our SDKs in different languages so you may check if yours is available in our repository. If you don't find your language in the list, feel free to request it from us, or use raw REST API requests as you can find it here.
Code generator
The solution is updated using code generator.