lovell / lovell/sharp

Get operation progress information with handler function

Open
#2,189 1 comment 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
32.7k
Forks
1.4k
Avg merge
1d 14h
Merged PRs (30d)
5

Description

First of all, thanks for the great job done with sharp !!! It is a very powerful tool for images manipulation...

I would like to get some information about progression (percentage or weight) of current image operation (eg: crop, resize, tiles...)

I didn't found anything about this need in all existing issues...

I imagine a handler function injection like :
```js
var transformer = sharp()
.resize(300)
.on('progress', function(progress) {
console.log('Processing: ' + progress.percent + '% done');
});
```

I know libvips consider an environment variable named `VIPS_PROGRESS`, so I guess there is something to do ?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the sharp() transformation pipeline and the proposed 'progress' handler, then investigate how libvips' VIPS_PROGRESS environment variable reports operation progress. Define what progress should represent for operations such as crop, resize, and tiles, and confirm the API and behavior needed before considering the feature complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, nodejs
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.