From a982cfdb20e99fcb27d91e8a0cac895f65bd5bea Mon Sep 17 00:00:00 2001 From: Matt Hirsch Date: Thu, 7 Jul 2016 15:50:59 -0400 Subject: [PATCH] Update docs to better reflect output of RAW data (#499) --- docs/api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api.md b/docs/api.md index fbdb16dd5..139a4e38a 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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: @@ -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: