Docs: composite image supports the animated property #3135

lovell · Mar 14, 2022 · ac883c5 · ac883c5
1 parent e8720c9
commit ac883c5
Show file tree

Hide file tree

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