jimp-dev/jimp

What is required to get Jimp supporting synchronus image loading/creating?

Open

#917 opened on Jul 25, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (13,218 stars) (785 forks)batch import
enhancementhelp wanted

Description

I would like to be able to load an image from a file (though any source would be best) and know when it was available for manipulation in a synchronous way. To know when individual manipulations have completed. My application would like to load a number of images sequentially (validating input) and then once all are validating, start processing them though separate/different/combined sequences.

Calling Jimp.load(, <WITH SOMETHING INDICATING DON'T USE PROMISES>) to return an object that can be manipulated and cloned.

Tried finding a library that doesn't require some tortuous combinations of Promises that ultimately don't work for just simply loading an image file and knowing when it has been loaded and is manipulatable.

Contributor guide

Tech stack
javascriptnodejs
Domain
backend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
JavaScriptNode.jsAsync/awaitJimp internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Review the Jimp source code, particularly the image loading functions in /packages/core/src/index.js. Understand how the existing asynchronous (promise based) API works, especially the `Jimp.read` method. Determine the minimal changes required to add a synchronous alternative, possibly by wrapping the promise based code with synchronous wrappers using libraries like `deasync` or by restructuring to support both synchronous and asynchronous flows. Check the issue comments and any related PRs for additional context.
What is required to get Jimp supporting synchronus image loading/creating? · jimp-dev/jimp#917 | Good First Issue