From 34cbc6dec3d57531341b96fcba79214f4669f7be Mon Sep 17 00:00:00 2001 From: Lovell Fuller Date: Thu, 23 Feb 2023 10:33:13 +0000 Subject: [PATCH] Docs: clarify that paths are relative to process working dir --- docs/api-output.md | 2 +- lib/output.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api-output.md b/docs/api-output.md index b38b011f..1cc0b887 100644 --- a/docs/api-output.md +++ b/docs/api-output.md @@ -127,7 +127,7 @@ EXIF metadata is unsupported for TIFF output. | --- | --- | --- | --- | | [options] | Object | | | | [options.orientation] | number | | value between 1 and 8, used to update the EXIF `Orientation` tag. | -| [options.icc] | string | | filesystem path to output ICC profile, defaults to sRGB. | +| [options.icc] | string | "'srgb'" | Filesystem path to output ICC profile, relative to `process.cwd()`, defaults to built-in sRGB. | | [options.exif] | Object.<Object> | {} | Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data. | | [options.density] | number | | Number of pixels per inch (DPI). | diff --git a/lib/output.js b/lib/output.js index 21881eb6..1a16262b 100644 --- a/lib/output.js +++ b/lib/output.js @@ -193,7 +193,7 @@ function toBuffer (options, callback) { * * @param {Object} [options] * @param {number} [options.orientation] value between 1 and 8, used to update the EXIF `Orientation` tag. - * @param {string} [options.icc] filesystem path to output ICC profile, defaults to sRGB. + * @param {string} [options.icc='srgb'] Filesystem path to output ICC profile, relative to `process.cwd()`, defaults to built-in sRGB. * @param {Object} [options.exif={}] Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data. * @param {number} [options.density] Number of pixels per inch (DPI). * @returns {Sharp}