jimp-dev/jimp

Documentation! Why none of the examples in plugins-* mention about writing the processed image back to the file-system?

Open

#897 geöffnet am 28. Mai 2020

Auf GitHub ansehen
 (0 Kommentare) (1 Reaktion) (0 zugewiesene Personen)JavaScript (13.218 Stars) (785 Forks)batch import
documentationhelp wantedsolution in issue

Beschreibung

I stumbled upon this library when I was looking for an image manipulation lib on the server side. When I copy pasted the examples mentioned in plugins-resize, plugins-blur, it just executes! And the original image remains as it is! I was puzzled for a while and I even passed a callback with a console statement which worked fine but the input image just didn't change!

All the code examples in default plugins only shows how to read and how to apply it.

It would save a lot of beginners time if those examples had one more line that saves the output to filesystem: image.write('output.jpg');

Contributor Guide

Tech Stack
javascriptnodejs
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
95
Research-Richtung
Examine the example code in the plugins * directories (e.g., plugins resize, plugins blur) within the repository. For each example, after applying the image processing operation, add a line to write the processed image to the filesystem using `image.write('output.jpg')`. Update the corresponding documentation files accordingly. Ensure consistency across all plugins.