Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-07-09 18:40:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: composite supports failOnError and limitInputPixels

Browse Source
This commit is contained in:
Lovell Fuller 2021-05-15 14:52:33 +01:00
parent 5bd5e5052a
commit 81e388a4cc
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api-composite.md
View File

@ -41,6 +41,8 @@ and [https://www.cairographics.org/operators/][2]
* `images[].raw.width` **[Number][7]?** * `images[].raw.width` **[Number][7]?**
* `images[].raw.height` **[Number][7]?** * `images[].raw.height` **[Number][7]?**
* `images[].raw.channels` **[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 ### Examples
@ -61,7 +63,7 @@ sharp('input.png')
}); });
``` ```
* Throws **[Error][10]** Invalid parameters * Throws **[Error][11]** Invalid parameters
Returns **Sharp** Returns **Sharp**
@ -87,4 +89,6 @@ Returns **Sharp**
[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean [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

2
lib/composite.js
View File

@ -89,6 +89,8 @@ const blend = {
* @param {Number} [images[].raw.width] * @param {Number} [images[].raw.width]
* @param {Number} [images[].raw.height] * @param {Number} [images[].raw.height]
* @param {Number} [images[].raw.channels] * @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} * @returns {Sharp}
* @throws {Error} Invalid parameters * @throws {Error} Invalid parameters
*/ */