Skip to content

Commit

Permalink
Update docs to better reflect output of RAW data (#499)
Browse files Browse the repository at this point in the history
  • Loading branch information
@mhirsch @lovell
mhirsch authored and lovell committed Jul 7, 2016
1 parent 7689fbe commit a982cfd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ sharp('input.png')

`path` is a String containing the path to write the image data to.

If an explicit output format is not selected, it will be inferred from the extension, with JPEG, PNG, WebP, TIFF and DZI supported.
If an explicit output format is not selected, it will be inferred from the extension, with JPEG, PNG, WebP, TIFF and DZI supported. Note that RAW format is only supported for buffer output.

`callback`, if present, is called with two arguments `(err, info)` where:

Expand All @@ -500,7 +500,7 @@ A Promises/A+ promise is returned when `callback` is not provided.

#### toBuffer([callback])

Write image data to a Buffer, the format of which will match the input image by default. JPEG, PNG and WebP are supported.
Write image data to a Buffer, the format of which will match the input image by default. JPEG, PNG, WebP, and RAW are supported.

`callback`, if present, gets three arguments `(err, buffer, info)` where:

Expand Down

0 comments on commit a982cfd

Please sign in to comment.