Docs: clarify that metadata respects page/pages

This commit is contained in:
Lovell Fuller
2022-09-01 09:58:17 +01:00
parent 4b38f56d02
commit 0e3bd46ca3
2 changed files with 21 additions and 13 deletions

View File

@@ -390,6 +390,9 @@ function _isStreamInput () {
* 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.
*
* Dimensions in the response will respect the `page` and `pages` properties of the
* {@link /api-constructor#parameters|constructor parameters}.
*
* A `Promise` is returned when `callback` is not provided.
*
* - `format`: Name of decoder used to decompress image data e.g. `jpeg`, `png`, `webp`, `gif`, `svg`