Skip to content

Commit f19998e

Browse files
committed
Add more default values
1 parent 2946f62 commit f19998e

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/api/native-image.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -247,8 +247,8 @@ Returns `NativeImage` - The cropped image.
247247
#### `image.resize(options)`
248248

249249
* `options` Object
250-
* `width` Integer (optional)
251-
* `height` Integer (optional)
250+
* `width` Integer (optional) - Defaults to the image's width.
251+
* `height` Integer (optional) - Defaults to the image's height
252252
* `quality` String (optional) - The desired quality of the resize image.
253253
Possible values are `good`, `better` or `best`. The default is `best`.
254254
These values express a desired quality/speed tradeoff. They are translated
@@ -269,8 +269,10 @@ Returns `Float` - The image's aspect ratio.
269269

270270
* `options` Object
271271
* `scaleFactor` Double - The scale factor to add the image representation for.
272-
* `width` Integer (optional)
273-
* `height` Integer (optional)
272+
* `width` Integer (optional) - Defaults to 0. Required if a bitmap buffer
273+
is specified as `buffer`.
274+
* `height` Integer (optional) - Defaults to 0. Required if a bitmap buffer
275+
is specified as `buffer`.
274276
* `buffer` Buffer (optional) - The buffer containing the raw image data.
275277
* `dataURL` String (optional) - The data URL containing either a base 64
276278
encoded PNG or JPEG image.

0 commit comments

Comments
 (0)