From 0bc79cdb953c9c0f1cf9015be65fb231fd5ec520 Mon Sep 17 00:00:00 2001 From: Lovell Fuller Date: Fri, 28 Jul 2023 16:04:02 +0100 Subject: [PATCH] Docs: include paletteBitDepth metadata --- docs/api-input.md | 1 + lib/input.js | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/api-input.md b/docs/api-input.md index 75734aa2..b720bd14 100644 --- a/docs/api-input.md +++ b/docs/api-input.md @@ -22,6 +22,7 @@ A `Promise` is returned when `callback` is not provided. - `isProgressive`: Boolean indicating whether the image is interlaced using a progressive scan - `pages`: Number of pages/frames contained within the image, with support for TIFF, HEIF, PDF, animated GIF and animated WebP - `pageHeight`: Number of pixels high each page in a multi-page image will be. +- `paletteBitDepth`: Bit depth of palette-based image (GIF, PNG). - `loop`: Number of times to loop an animated image, zero refers to a continuous loop. - `delay`: Delay in ms between each page in an animated image, provided as an array of integers. - `pagePrimary`: Number of the primary page in a HEIF image diff --git a/lib/input.js b/lib/input.js index b59c0f7a..0fd4bad6 100644 --- a/lib/input.js +++ b/lib/input.js @@ -432,6 +432,7 @@ function _isStreamInput () { * - `isProgressive`: Boolean indicating whether the image is interlaced using a progressive scan * - `pages`: Number of pages/frames contained within the image, with support for TIFF, HEIF, PDF, animated GIF and animated WebP * - `pageHeight`: Number of pixels high each page in a multi-page image will be. + * - `paletteBitDepth`: Bit depth of palette-based image (GIF, PNG). * - `loop`: Number of times to loop an animated image, zero refers to a continuous loop. * - `delay`: Delay in ms between each page in an animated image, provided as an array of integers. * - `pagePrimary`: Number of the primary page in a HEIF image