Update docs to better reflect output of RAW data #499

mhirsch · 2016-07-07T16:02:58Z

Tiny pr to document something that I initially found confusing. I expected

sharp(input).raw().toFile('c.raw');

to write a raw dump of the image in uint8, but instead I get an error:

Unhandled rejection Error: Unsupported output format c.raw
    at Error (native)

lovell · 2016-07-07T18:29:39Z

docs/api.md

@@ -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.


Please can you move the comma :)

lovell · 2016-07-07T18:30:18Z

Thanks. Perhaps raw file output should be made available? Feel free to open a new issue if you need this.

mhirsch · 2016-07-07T19:04:34Z

I don't particularly need that feature right now. Nice to have it documented. Thanks for your feedback!

Update docs to better reflect output of RAW data

dbf8848

lovell reviewed Jul 7, 2016
View reviewed changes

Insert comma

1f54e17

lovell merged commit a982cfd into lovell:master Jul 7, 2016

lovell added this to the v0.15.1 milestone Jul 7, 2016

mhirsch deleted the raw_doc_update branch July 7, 2016 20:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update docs to better reflect output of RAW data #499

Update docs to better reflect output of RAW data #499

mhirsch commented Jul 7, 2016

lovell Jul 7, 2016

lovell commented Jul 7, 2016

mhirsch commented Jul 7, 2016

Update docs to better reflect output of RAW data #499

Update docs to better reflect output of RAW data #499

Conversation

mhirsch commented Jul 7, 2016

lovell Jul 7, 2016

Choose a reason for hiding this comment

lovell commented Jul 7, 2016

mhirsch commented Jul 7, 2016