Skip to content
This repository was archived by the owner on May 1, 2025. It is now read-only.

Commit 6c033fe

Browse files
author
Hans Kristian Flaatten
committed
Merge pull request #32 from anthonyringoet/readme-format
Add missing format parameter documentation
2 parents beac789 + acc17c5 commit 6c033fe

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ var Upload = require('s3-uploader');
6767
* **object[]** `versions`
6868
* **string** `suffix` - image file name suffix (**default** `""`)
6969
* **number** `quality` - image resize quality
70+
* **string** `format` - force output image file format (**default** `format of original image`)
7071
* **number** `maxWidth` - max width for resized image
7172
* **number** `maxHeight` - max height for resized image
7273
* **string** `aspect` - force aspect ratio for resized image (**example:** `4:3`
@@ -104,6 +105,7 @@ var client = new Upload('my_s3_bucket', {
104105
versions: [{
105106
maxHeight: 1040,
106107
maxWidth: 1040,
108+
format: 'jpg',
107109
suffix: '-large',
108110
quality: 80
109111
},{

0 commit comments

Comments
 (0)