You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-7Lines changed: 17 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,16 @@
18
18
npm install heic-convert
19
19
```
20
20
21
+
## Usage
22
+
23
+
You can convert the first image in a HEIC, or convert all images in the file. In both cases, the options are the same.
24
+
25
+
### options object
26
+
27
+
*`buffer` - a Node [`Buffer`](https://nodejs.org/api/buffer.html) or a [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) - the HEIC image to convert
28
+
*`format` - string - either `JPEG` or `PNG`
29
+
*`quality` - number between `0` and `1`, optional - the lossy compression quality to be used when converting to jpeg.
0 commit comments