jimp-dev/jimp

Clarify documentation: callback not required to create an image

Open

#957 opened on Oct 24, 2020

View on GitHub
 (1 comment) (1 reaction) (0 assignees)JavaScript (13,218 stars) (785 forks)batch import
documentationhelp wantedsolution in issue

Description

The documentation says:

Iyou want to begin with an empty Jimp image, you can call the Jimp constructor passing the width and height of the image to create and a Node-style callback:

 new Jimp(256, 256, (err, image) => {
  // this image is 256 x 256, every pixel is set to 0x00000000
});

However, it works fine to not pass the callback:

const image = new Jimp(256, 256);

Not sure if both options are valid, but it would have made my code simpler from the start if I realised I didn't need the callback.

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic JavaScriptfamiliarity with Jimp library
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Locate the documentation section describing the Jimp constructor (likely in README or website). Update the example to show that the callback is optional, or add a note clarifying both usages. Ensure consistency with the library's actual API behavior.