Docs: include paletteBitDepth metadata

lovell · Jul 28, 2023 · 0bc79cd · 0bc79cd
1 parent 9a66e25
commit 0bc79cd
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git 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
@@ -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