From e627f6d68da65916728353300eaf3e24e8614bce Mon Sep 17 00:00:00 2001 From: Lovell Fuller Date: Sat, 5 Oct 2019 08:43:40 +0100 Subject: [PATCH] Docs: clarify that input 'path' refers to the filesystem --- docs/api-constructor.md | 2 +- lib/constructor.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api-constructor.md b/docs/api-constructor.md index f59661e1..1f98241c 100644 --- a/docs/api-constructor.md +++ b/docs/api-constructor.md @@ -6,7 +6,7 @@ - `input` **([Buffer][1] \| [String][2])?** if present, can be a Buffer containing JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data, or - a String containing the path to an JPEG, PNG, WebP, GIF, SVG or TIFF image file. + a String containing the filesystem path to an JPEG, PNG, WebP, GIF, SVG or TIFF image file. JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when not present. - `options` **[Object][3]?** if present, is an Object with optional attributes. - `options.failOnError` **[Boolean][4]** by default halt processing and raise an error when loading invalid images. diff --git a/lib/constructor.js b/lib/constructor.js index f6a6c6d1..bfbfebad 100644 --- a/lib/constructor.js +++ b/lib/constructor.js @@ -78,7 +78,7 @@ const debuglog = util.debuglog('sharp'); * * @param {(Buffer|String)} [input] - if present, can be * a Buffer containing JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data, or - * a String containing the path to an JPEG, PNG, WebP, GIF, SVG or TIFF image file. + * a String containing the filesystem path to an JPEG, PNG, WebP, GIF, SVG or TIFF image file. * JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when not present. * @param {Object} [options] - if present, is an Object with optional attributes. * @param {Boolean} [options.failOnError=true] - by default halt processing and raise an error when loading invalid images.