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

image-transform-api

v0.0.1

Published

A Node JS application that exposes APIs that transform uploaded images (crop, rotate, resize) and allow for download post-transformation

Downloads

5

Readme

ImageManipulationAPI

A Node JS application that exposes APIs that transform uploaded images (crop, rotate, resize) and allow for their download post-transformation

Pre-requisites:

You need to have these installed:

  • Git
  • Node JS

Get started by:

Perform these steps using your CLI tool:

  1. Clone this repository (usually with git clone <REPO_URL>)
  2. Install required packages with npm install
  3. Start the application with npm start

API endpoints:

The application exposes the APIs:

1. URL: "/upload"

Method: POST

Acceptable Data (Request Body):

  • image: This would contain the file data

  • crop: e.g { crop: "x=2;y=4;w=3;h=10" }

    x - horizontal distance from origin,

    y - vertical distance from origin,

    w - the width of new image,

    h - the height of new image

  • scale: e.g { scale: "f=1.5" }

    f - scale factor

  • resize: e.g { resize: "w=3;h=10" }

    w - the width of new image,

    h - the height of new image

  • rotate: e.g { rotate: "d=90" }

    d - degrees

  • order: e.g { order: "sc;re;ro;cr" }

    sc - scale

    re - resize

    ro - rotate

    cr - crop

    //default order: "re;ro;sc;cr" meaning the worker should first 'resize', then 'rotate', then 'scale' and lastly 'crop' the parsed image.

    Example:

    axios({
        method: 'post',
        url: '/upload',
        data: {
            image: imageFile,
            crop: "x=2;y=4;w=3;h=10",
            scale: "f=1.5",
            resize: "w=3;h=10",
            rotate: "d=90",
            order: "sc;ro;re;cr"
        }
    })
     .then(function (response) {
        //handle success
        console.log(response);
     })
     .catch(function (response) {
        //handle error
        console.log(response);
     });

2. URL: "/export"

Method: GET

Acceptable Data (Request Query):

  • to: e.g ?to=jpg // jpg, png, pdf or PDf (case insensitive)

    JPG - exports a JPEG image,

    PNG - exports a PNG image,

    PDF - exports a PDF document,

    Example:

     // For the "/export" endpoint
    axios({
        method: 'get',
        url: '/export?to=PDF'
    })
     .then(function (response) {
        //handle success
        console.log(response);
     })
     .catch(function (response) {
        //handle error
        console.log(response);
     });