From 00bcf605668e93d07bce700f98dc8822b859fb1a Mon Sep 17 00:00:00 2001 From: Lovell Fuller Date: Thu, 9 Jan 2020 23:04:06 +0000 Subject: [PATCH] Docs: metadata delay/loop properties --- docs/api-input.md | 4 +++- lib/input.js | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/api-input.md b/docs/api-input.md index 0455f59a..483671ec 100644 --- a/docs/api-input.md +++ b/docs/api-input.md @@ -16,7 +16,9 @@ A `Promise` is returned when `callback` is not provided. - `chromaSubsampling`: String containing JPEG chroma subsampling, `4:2:0` or `4:4:4` for RGB, `4:2:0:4` or `4:4:4:4` for CMYK - `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 this PDF image will be. +- `pageHeight`: Number of pixels high each page in a multi-page image will be. +- `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 - `hasProfile`: Boolean indicating the presence of an embedded ICC profile - `hasAlpha`: Boolean indicating the presence of an alpha transparency channel diff --git a/lib/input.js b/lib/input.js index 082693d8..5aa28278 100644 --- a/lib/input.js +++ b/lib/input.js @@ -167,7 +167,9 @@ function _isStreamInput () { * - `chromaSubsampling`: String containing JPEG chroma subsampling, `4:2:0` or `4:4:4` for RGB, `4:2:0:4` or `4:4:4:4` for CMYK * - `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 this PDF image will be. + * - `pageHeight`: Number of pixels high each page in a multi-page image will be. + * - `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 * - `hasProfile`: Boolean indicating the presence of an embedded ICC profile * - `hasAlpha`: Boolean indicating the presence of an alpha transparency channel