npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

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

Readme

Pixaven



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.