image-parser

An image parser that works.

This library uses lwip to parse the images falling back to GraphicsMagick. :art:

:cloud: Installation

# Using npm
npm install --save image-parser

# Using yarn
yarn add image-parser

:clipboard: Example

const ImageParser = require("image-parser");

let img = new ImageParser("https://octodex.github.com/images/privateinvestocat.jpg");
img.parse(err => {
    if (err) { return console.error(err); }
    console.log(img.getPixel(3, 3));
    // PixelClass { r: 34, g: 30, b: 31, a: 1 }
});

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

ImageParser(source, options)

Creates a new instance of ImageParser.

Params

• String|Buffer source: The image path/url or the a Buffer object.
• Object options: The options object to pass to the lwipify.

Return

• ImageParser The ImageParser instance.

parse(cb)

Prepare the in-memory data (image pixels, buffers, size etc).

Params

• Function cb: The callback function.

width()

Returns the image width.

Return

• Number The image width.

height()

Returns the image height.

Return

• Number The image height.

getPixel(x, y)

Gets the pixel at given coordinates.

Params

• Number x: The x coordinate.
• Number y: The y coordinate.

Return

• Pixel The Pixel instance containing the pixel data.

pixels()

Gets the image pixels.

Return

• Array An array of Pixel objects containing the pixel information.

resize(width, height, cb)

Resizes the image.

Params

• Number width: The new image width.
• Number height: The new image height.
• Function cb: The callback function.

crop(width, height, x, y, cb)

Crops the image.

Params

• Number width: The crop width.
• Number height: The crop height.
• Number x: The X coordinate.
• Number y: The Y coordinate.
• Function cb: The callback function.

save(filePath, cb)

Saves the image to disk.

Params

• String filePath: The output file path.
• Function cb: The callback function.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• @0x7/render-label
• image-to-ascii
• img-ssim
• img-to-ascii

:scroll: License

MIT © Ionică Bizău