diff --git a/docs/api-constructor.md b/docs/api-constructor.md index 2d6e8e92..b8b4bdfc 100644 --- a/docs/api-constructor.md +++ b/docs/api-constructor.md @@ -77,7 +77,7 @@ An Object containing nested boolean values representing the available input and **Examples** ```javascript -console.log(sharp.format()); +console.log(sharp.format); ``` Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** diff --git a/docs/api-output.md b/docs/api-output.md index 39534f54..a846f739 100644 --- a/docs/api-output.md +++ b/docs/api-output.md @@ -140,6 +140,7 @@ Use these TIFF options for output image. - `options.force` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** force TIFF output, otherwise attempt to use input format (optional, default `true`) - `options.compression` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** compression options: lzw, deflate, jpeg (optional, default `'jpeg'`) - `options.predictor` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** compression predictor options: none, horizontal, float (optional, default `'none'`) + - `options.squash` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** squash 8-bit images down to 1 bit (optional, default `false`) - Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid options diff --git a/lib/constructor.js b/lib/constructor.js index e942001a..d73e586d 100644 --- a/lib/constructor.js +++ b/lib/constructor.js @@ -217,7 +217,7 @@ Sharp.queue = queue; /** * An Object containing nested boolean values representing the available input and output formats/methods. * @example - * console.log(sharp.format()); + * console.log(sharp.format); * @returns {Object} */ Sharp.format = sharp.format();