Docs: metadata returns resolutionUnit, if present

lovell · Jan 29, 2022 · 47ae1f5 · 47ae1f5
1 parent ec17d7f
commit 47ae1f5
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 5 deletions.
diff --git a/docs/api-input.md b/docs/api-input.md
@@ -28,6 +28,7 @@ A `Promise` is returned when `callback` is not provided.
 *   `subifds`: Number of Sub Image File Directories in an OME-TIFF image
 *   `background`: Default background colour, if present, for PNG (bKGD) and GIF images, either an RGB Object or a single greyscale value
 *   `compression`: The encoder used to compress an HEIF file, `av1` (AVIF) or `hevc` (HEIC)
+*   `resolutionUnit`: The unit of resolution (density), either `inch` or `cm`, if present
 *   `hasProfile`: Boolean indicating the presence of an embedded ICC profile
 *   `hasAlpha`: Boolean indicating the presence of an alpha transparency channel
 *   `orientation`: Number value of the EXIF Orientation header, if present

diff --git a/lib/input.js b/lib/input.js
@@ -316,6 +316,7 @@ function _isStreamInput () {
  * - `subifds`: Number of Sub Image File Directories in an OME-TIFF image
  * - `background`: Default background colour, if present, for PNG (bKGD) and GIF images, either an RGB Object or a single greyscale value
  * - `compression`: The encoder used to compress an HEIF file, `av1` (AVIF) or `hevc` (HEIC)
+ * - `resolutionUnit`: The unit of resolution (density), either `inch` or `cm`, if present
  * - `hasProfile`: Boolean indicating the presence of an embedded ICC profile
  * - `hasAlpha`: Boolean indicating the presence of an alpha transparency channel
  * - `orientation`: Number value of the EXIF Orientation header, if present

diff --git a/src/pipeline.cc b/src/pipeline.cc
@@ -1443,7 +1443,6 @@ Napi::Value pipeline(const Napi::CallbackInfo& info) {
   baton->affineOdx = sharp::AttrAsDouble(options, "affineOdx");
   baton->affineOdy = sharp::AttrAsDouble(options, "affineOdy");
   baton->affineInterpolator = vips::VInterpolate::new_from_name(sharp::AttrAsStr(options, "affineInterpolator").data());
-
   baton->removeAlpha = sharp::AttrAsBool(options, "removeAlpha");
   baton->ensureAlpha = sharp::AttrAsDouble(options, "ensureAlpha");
   if (options.Has("boolean")) {
@@ -1555,21 +1554,17 @@ Napi::Value pipeline(const Napi::CallbackInfo& info) {
     sharp::AttrAsStr(options, "heifCompression").data()));
   baton->heifEffort = sharp::AttrAsUint32(options, "heifEffort");
   baton->heifChromaSubsampling = sharp::AttrAsStr(options, "heifChromaSubsampling");
-
-
   // Raw output
   baton->rawDepth = static_cast<VipsBandFormat>(
     vips_enum_from_nick(nullptr, VIPS_TYPE_BAND_FORMAT,
     sharp::AttrAsStr(options, "rawDepth").data()));
-
   // Animated output properties
   if (sharp::HasAttr(options, "loop")) {
     baton->loop = sharp::AttrAsUint32(options, "loop");
   }
   if (sharp::HasAttr(options, "delay")) {
     baton->delay = sharp::AttrAsInt32Vector(options, "delay");
   }
-
   // Tile output
   baton->tileSize = sharp::AttrAsUint32(options, "tileSize");
   baton->tileOverlap = sharp::AttrAsUint32(options, "tileOverlap");