diff --git a/docs/api-composite.md b/docs/api-composite.md index 0378865c..3030a53a 100644 --- a/docs/api-composite.md +++ b/docs/api-composite.md @@ -41,6 +41,8 @@ and [https://www.cairographics.org/operators/][2] * `images[].raw.width` **[Number][7]?** * `images[].raw.height` **[Number][7]?** * `images[].raw.channels` **[Number][7]?** + * `images[].failOnError` **[boolean][9]** @see [constructor parameters][10] (optional, default `true`) + * `images[].limitInputPixels` **([number][7] | [boolean][9])** @see [constructor parameters][10] (optional, default `268402689`) ### Examples @@ -61,7 +63,7 @@ sharp('input.png') }); ``` -* Throws **[Error][10]** Invalid parameters +* Throws **[Error][11]** Invalid parameters Returns **Sharp** @@ -87,4 +89,6 @@ Returns **Sharp** [9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean -[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error +[10]: /api-constructor#parameters + +[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error diff --git a/lib/composite.js b/lib/composite.js index 88ab83cb..f3b736a6 100644 --- a/lib/composite.js +++ b/lib/composite.js @@ -89,6 +89,8 @@ const blend = { * @param {Number} [images[].raw.width] * @param {Number} [images[].raw.height] * @param {Number} [images[].raw.channels] + * @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} * @throws {Error} Invalid parameters */