diff --git a/docs/api-input.md b/docs/api-input.md index c1ff16cea..44a4e8397 100644 --- a/docs/api-input.md +++ b/docs/api-input.md @@ -42,7 +42,7 @@ A `Promise` is returned when `callback` is not provided. - `xmp`: Buffer containing raw XMP data, if present - `tifftagPhotoshop`: Buffer containing raw TIFFTAG_PHOTOSHOP data, if present - `formatMagick`: String containing format for images loaded via *magick -- `comments`: Array of keyword/text pairs representing PNG text blocks, if present. +- `comments`: Array of keyword/text pairs representing PNG text blocks, if present. diff --git a/docs/changelog.md b/docs/changelog.md index 3850f50ab..ab5c4d37a 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -20,6 +20,10 @@ Requires libvips v8.15.2 [#4147](https://github.com/lovell/sharp/pull/4147) [@ton11797](https://github.com/ton11797) +* Expose PNG text chunks as `comments` metadata. + [#4157](https://github.com/lovell/sharp/pull/4157) + [@nkeynes](https://github.com/nkeynes) + ### v0.33.4 - 16th May 2024 * Remove experimental status from `pipelineColourspace`. diff --git a/docs/humans.txt b/docs/humans.txt index 1c9cd1ceb..489e4a886 100644 --- a/docs/humans.txt +++ b/docs/humans.txt @@ -299,3 +299,6 @@ GitHub: https://github.com/project0 Name: Pongsatorn Manusopit GitHub: https://github.com/ton11797 + +Name: Nathan Keynes +GitHub: https://github.com/nkeynes diff --git a/lib/input.js b/lib/input.js index ae3eb9430..93d4e7411 100644 --- a/lib/input.js +++ b/lib/input.js @@ -450,7 +450,7 @@ function _isStreamInput () { * - `xmp`: Buffer containing raw XMP data, if present * - `tifftagPhotoshop`: Buffer containing raw TIFFTAG_PHOTOSHOP data, if present * - `formatMagick`: String containing format for images loaded via *magick - * - `comments` Array of keyword/text pairs representing PNG text blocks, if present. + * - `comments`: Array of keyword/text pairs representing PNG text blocks, if present. * * @example * const metadata = await sharp(input).metadata();