Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
@jimp/custom
Advanced tools
Configure jimp with types and plugins.
The following wil configure a jimp
instance with the same functionality as the main jimp
package.
import configure from '@jimp/custom';
// all of jimp's default types
import types from '@jimp/types';
// all of jimp's default types
import plugins from '@jimp/plugins';
configure({
types: [types],
plugins: [plugins]
});
Takes a Jimp configuration and applies it to @jimp/core
.
Sample Jimp configuration:
import types from '@jimp/types';
import bmp from '@jimp/bmp';
import jpeg from '@jimp/types';
...
configure({
types: [types]
})
// or
configure({
types: [bmp, jpeg, ...]
})
You can use configure to add more types and plugins to a jimp multiple times.
let jimp = configure({
types: [bmp]
});
jimp = configure(
{
types: [jpeg]
},
jimp
);
To define a new Jimp image type write a function the takes the current Jimp configuration. In this function you can extend Jimp's internal data structures.
This function must return and array whose first element is the mime type and second element is an array of valid file extensions.
const special = require('special-js');
const MIME_TYPE = 'image/special';
export default () => ({
mime: [MIME_TYPE, ['spec', 'special']],
constants: {
MIME_SPECIAL: MIME_TYPE
},
decoders: {
[MIME_TYPE]: data => special.decode(data)
},
encoders: {
[MIME_TYPE]: image => special.encode(image.bitmap)
}
});
A jimp image type can expose as many constants as it wants. Each jimp type is required to expose a mime type.
constants: {
MIME_SPECIAL: MIME_TYPE
},
A image type can define whether it supports an alpha channel.
hasAlpha: {
MIME_SPECIAL: true
},
A function that when supplied with a buffer should return a bitmap with height and width.
decoders: {
[MIME_TYPE]: data => special.decode(data)
},
A function that when supplied with a Jimp image should return an encoded buffer.
encoders: {
[MIME_TYPE]: image => special.encode(image.bitmap)
}
Add class properties and function to the Jimp constructor.
class: {
_quality: 100,
quality: function(n, cb) {
if (typeof n !== 'number') {
return throwError.call(this, 'n must be a number', cb);
}
if (n < 0 || n > 100) {
return throwError.call(this, 'n must be a number 0 - 100', cb);
}
this._quality = Math.round(n);
if (isNodePattern(cb)) {
cb.call(this, null, this);
}
return this;
}
};
Defining a plugin has access to all the same things in the type definition. Mainly plugins use just the constants
and class
config options.
Below is the invert
plugin. If a plugin doesn return an object with constants
and class
, all keys are treated as class functions.
import { isNodePattern } from '@jimp/utils';
/**
* Inverts the image
* @param {function(Error, Jimp)} cb (optional) a callback for when complete
* @returns {Jimp} this for chaining of methods
*/
export default () => ({
invert(cb) {
this.scanQuiet(0, 0, this.bitmap.width, this.bitmap.height, function(
x,
y,
idx
) {
this.bitmap.data[idx] = 255 - this.bitmap.data[idx];
this.bitmap.data[idx + 1] = 255 - this.bitmap.data[idx + 1];
this.bitmap.data[idx + 2] = 255 - this.bitmap.data[idx + 2];
});
if (isNodePattern(cb)) {
cb.call(this, null, this);
}
return this;
}
});
v0.6.8 (Tue Sep 03 2019)
jimp
FAQs
Interface to customize jimp configuration
The npm package @jimp/custom receives a total of 1,048,420 weekly downloads. As such, @jimp/custom popularity was classified as popular.
We found that @jimp/custom demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.