From ac883c52155df1410b5929414f1be3f9ec972370 Mon Sep 17 00:00:00 2001 From: Lovell Fuller Date: Mon, 14 Mar 2022 08:53:00 +0000 Subject: [PATCH] Docs: composite image supports the animated property #3135 --- docs/api-composite.md | 1 + lib/composite.js | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/api-composite.md b/docs/api-composite.md index 1f0d5df30..66df143f9 100644 --- a/docs/api-composite.md +++ b/docs/api-composite.md @@ -41,6 +41,7 @@ and [https://www.cairographics.org/operators/][2] * `images[].raw.width` **[Number][7]?** * `images[].raw.height` **[Number][7]?** * `images[].raw.channels` **[Number][7]?** + * `images[].animated` **[boolean][9]** Set to `true` to read all frames/pages of an animated image. (optional, default `false`) * `images[].failOnError` **[boolean][9]** @see [constructor parameters][10] (optional, default `true`) * `images[].limitInputPixels` **([number][7] | [boolean][9])** @see [constructor parameters][10] (optional, default `268402689`) diff --git a/lib/composite.js b/lib/composite.js index d42e4ec9f..9ba6b4194 100644 --- a/lib/composite.js +++ b/lib/composite.js @@ -104,6 +104,7 @@ const blend = { * @param {Number} [images[].raw.width] * @param {Number} [images[].raw.height] * @param {Number} [images[].raw.channels] + * @param {boolean} [images[].animated=false] - Set to `true` to read all frames/pages of an animated image. * @param {boolean} [images[].failOnError=true] - @see {@link /api-constructor#parameters|constructor parameters} * @param {number|boolean} [images[].limitInputPixels=268402689] - @see {@link /api-constructor#parameters|constructor parameters} * @returns {Sharp}