pixaven
v1.0.4
Published
Enterprise-grade image processing SaaS running entirely on Apple® platform. Resize, scale, crop, mask, filter and enhance your images with blazing speed.
Downloads
21
Maintainers
Readme
Documentation
See the Pixaven API docs.
Installation
$ npm install pixaven --save
Quick examples
Pixaven API enables you to provide your images for processing in two ways - by uploading them directly to the API (Image Upload) or by providing a publicly available image URL (Image Fetch).
You may also choose your preferred response method on a per-request basis. By default, the Pixaven API will return a JSON response with rich metadata pertaining to input and output images. Alternatively, you can use binary responses. When enabled, the API will respond with a full binary representation of the resulting (output) image. This Node module exposes two convenience methods for interacting with binary responses: .toFile()
and .toBuffer()
.
Image upload
Here is a quick example of uploading a local file for processing. It calls .toJSON()
at a final step and instructs the API to return a JSON response.
const Pixaven = require("pixaven");
// Pass your Pixaven API Key to the constructor
const pix = new Pixaven("your-api-key");
// Upload an image from disk, resize it to 100 x 75,
// automatically enhance, and adjust sharpness parameter
pix
.upload("path/to/input.jpg")
.resize({
width: 100,
height: 75
})
.auto({
enhance: true
})
.adjust({
unsharp: 10
})
.toJSON((err, meta) => {
if (err) {
return console.log(err);
}
// You'll find the full JSON metadata within the `meta` object
if (meta.success) {
console.log(meta.output.url);
} else {
console.log(meta.message);
}
});
Image fetch
If you already have your source visuals publicly available online, we recommend using Image Fetch by default. That way you only have to send a JSON payload containing image URL and processing steps. This method is also much faster than uploading a full binary representation of the image.
const Pixaven = require("pixaven");
// Pass your Pixaven API Key to the constructor
const pix = new Pixaven("your-api-key");
// Provide a publicly available image URL with `.fetch()` method,
// apply Gaussian blur using PNG as the output format.
// We'll also use `.toFile()` method and stream the output image to disk
pix
.fetch("https://www.website.com/image.jpg")
.filter({
blur: {
mode: "gaussian",
value: 10
}
})
.output({
format: "png"
})
.toFile("path/to/output.png", (err, meta) => {
if (err) {
return console.log(err);
}
// You'll find the full JSON metadata within the `meta` object
if (meta.success) {
console.log(meta.output.url);
} else {
console.log(meta.message);
}
});
License
This software is distributed under the MIT License. See the LICENSE file for more information.