@jimp/core
    TypeScript icon, indicating that this package has built-in type declarations

    0.16.1 • Public • Published

    @jimp/core

    The main Jimp class. This class can be extended with types and bitmap manipulation functions. Out of the box it does not support any image type.

    Available Methods

    Jimp

    The Jimp class constructor.

    addConstants

    Add constant or static methods to the Jimp constructor.

    addConstants({
      MIME_SPECIAL: 'image/special'
    });

    addJimpMethods

    Add a bitmap manipulation method to Jimp constructor. These method should return this so that the function can be chain-able.

    addJimpMethods({
      cropCrazy: function() {
        // Your custom image manipulation method
     
        return this;
      }
    })
     
    const image = await Jimp.read(...);
     
    image.resize(10, Jimp.AUTO),
      .cropCrazy();
     
    await image.writeAsync('test.png');

    addType

    Add a image mime type to Jimp constructor. First argument is a mime type and the second is an array of file extension for that type.

    addType('image/special', ['spec', 'special']);

    Keywords

    none

    Install

    npm i @jimp/core

    DownloadsWeekly Downloads

    1,089,264

    Version

    0.16.1

    License

    MIT

    Unpacked Size

    413 kB

    Total Files

    46

    Last publish

    Collaborators

    • alisowski
    • oliver.moran