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

Allow toBuffer to resolve Promise with info+data #143

Browse Source
This commit is contained in:
Lovell Fuller
2017-03-04 22:15:31 +00:00
parent 679ce08998
commit 6fe5b307b1
5 changed files with 89 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api-output.md
View File

@@ -40,15 +40,17 @@ Write output to a Buffer.
JPEG, PNG, WebP, and RAW output are supported.
By default, the format will match the input image, except GIF and SVG input which become PNG output.
`callback`, if present, gets three arguments `(err, buffer, info)` where:
`callback`, if present, gets three arguments `(err, data, info)` where:
- `err` is an error message, if any.
- `buffer` is the output image data.
- `err` is an error, if any.
- `data` is the output image data.
- `info` contains the output image `format`, `size` (bytes), `width`, `height` and `channels`.
A Promises/A+ promise is returned when `callback` is not provided.
A Promise is returned when `callback` is not provided.
**Parameters**
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?**
- `options.resolveWithObject` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Resolve the Promise with an Object containing `data` and `info` properties instead of resolving only with `data`.
- `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)?**
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Buffer](https://nodejs.org/api/buffer.html)>** when no callback is provided

6
docs/changelog.md
View File

@@ -4,6 +4,12 @@
Requires libvips v8.4.2.
#### v0.17.3 - TBD
* Allow toBuffer to optionally resolve a Promise with both info and data.
[#143](https://github.com/lovell/sharp/issues/143)
[@salzhrani](https://github.com/salzhrani)
#### v0.17.2 - 11<sup>th</sup> February 2017
* Ensure Readable side of Stream can start flowing after Writable side has finished.