Docs: clarify use of integral pixel values for extract

This commit is contained in:
Lovell Fuller
2019-04-01 20:06:46 +01:00
parent fc178de309
commit 6032171f91
2 changed files with 6 additions and 6 deletions

View File

@@ -334,11 +334,11 @@ function extend (extend) {
* // Extract a region, resize, then extract from the resized image
* });
*
* @param {Object} options
* @param {Object} options - describes the region to extract using integral pixel values
* @param {Number} options.left - zero-indexed offset from left edge
* @param {Number} options.top - zero-indexed offset from top edge
* @param {Number} options.width - dimension of extracted image
* @param {Number} options.height - dimension of extracted image
* @param {Number} options.width - width of region to extract
* @param {Number} options.height - height of region to extract
* @returns {Sharp}
* @throws {Error} Invalid parameters
*/