From fc03fba6021f2b24275d7cc2edc7390f229b7543 Mon Sep 17 00:00:00 2001 From: Lovell Fuller Date: Fri, 10 Mar 2023 13:35:06 +0000 Subject: [PATCH] Docs: clarify metadata ignores chained ops --- docs/api-input.md | 5 +++-- lib/input.js | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/api-input.md b/docs/api-input.md index d68e03dd..75734aa2 100644 --- a/docs/api-input.md +++ b/docs/api-input.md @@ -1,8 +1,9 @@ ## metadata Fast access to (uncached) image metadata without decoding any compressed pixel data. -This is taken from the header of the input image. -It does not include operations, such as resize, to be applied to the output image. +This is read from the header of the input image. +It does not take into consideration any operations to be applied to the output image, +such as resize or rotate. Dimensions in the response will respect the `page` and `pages` properties of the [constructor parameters](/api-constructor#parameters). diff --git a/lib/input.js b/lib/input.js index 56779f2f..b59c0f7a 100644 --- a/lib/input.js +++ b/lib/input.js @@ -411,8 +411,9 @@ function _isStreamInput () { /** * Fast access to (uncached) image metadata without decoding any compressed pixel data. * - * This is taken from the header of the input image. - * It does not include operations, such as resize, to be applied to the output image. + * This is read from the header of the input image. + * It does not take into consideration any operations to be applied to the output image, + * such as resize or rotate. * * Dimensions in the response will respect the `page` and `pages` properties of the * {@link /api-constructor#parameters|constructor parameters}.