Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-12-19 15:25:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

Refresh resize docs to ensure options are present

Browse Source
This commit is contained in:
Lovell Fuller
2018-10-02 18:45:08 +01:00
parent db4df6f0b2
commit c431909f35
2 changed files with 23 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
lib/resize.js
View File

@@ -174,6 +174,7 @@ const mapFitToCanvas = {
*
* @param {Number} [width] - pixels wide the resultant image should be. Use `null` or `undefined` to auto-scale the width to match the height.
* @param {Number} [height] - pixels high the resultant image should be. Use `null` or `undefined` to auto-scale the height to match the width.
* @param {Object} [options]
* @param {String} [options.width] - alternative means of specifying `width`. If both are present this take priority.
* @param {String} [options.height] - alternative means of specifying `height`. If both are present this take priority.
* @param {String} [options.fit='cover'] - how the image should be resized to fit both provided dimensions, one of `cover`, `contain`, `fill`, `inside` or `outside`.