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

Doc refresh for #1077

Browse Source
This commit is contained in:
Lovell Fuller 2018-01-13 10:27:43 +00:00
parent 573836e2b8
commit ebae68d579
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/api-resize.md
View File

@ -163,6 +163,7 @@ Returns **Sharp**
Do not enlarge the output image if the input image width _or_ height are already less than the required dimensions. Do not enlarge the output image if the input image width _or_ height are already less than the required dimensions.
This is equivalent to GraphicsMagick's `>` geometry option: This is equivalent to GraphicsMagick's `>` geometry option:
"_change the dimensions of the image only if its width or height exceeds the geometry specification_". "_change the dimensions of the image only if its width or height exceeds the geometry specification_".
Use with `max()` to preserve the image's aspect ratio.
The default behaviour _before_ function call is `false`, meaning the image will be enlarged. The default behaviour _before_ function call is `false`, meaning the image will be enlarged.