Docs: clarify that paths are relative to process working dir

This commit is contained in:
Lovell Fuller
2023-02-23 10:33:13 +00:00
parent bb8de0cc26
commit 34cbc6dec3
2 changed files with 2 additions and 2 deletions

View File

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