diff --git a/docs/api-colour.md b/docs/api-colour.md index 4594a6e3..87af7e2e 100644 --- a/docs/api-colour.md +++ b/docs/api-colour.md @@ -55,7 +55,8 @@ Alternative spelling of `greyscale`. Set the pipeline colourspace. The input image will be converted to the provided colourspace at the start of the pipeline. -All operations will use this colourspace before converting to the output colourspace, as defined by [toColourspace](#toColourspace). +All operations will use this colourspace before converting to the output colourspace, +as defined by [toColourspace](#tocolourspace). This feature is experimental and has not yet been fully-tested with all operations. diff --git a/docs/api-output.md b/docs/api-output.md index 8d997fdb..49cd12c7 100644 --- a/docs/api-output.md +++ b/docs/api-output.md @@ -6,7 +6,7 @@ with JPEG, PNG, WebP, AVIF, TIFF, GIF, DZI, and libvips' V format supported. Note that raw pixel data is only supported for buffer output. By default all metadata will be removed, which includes EXIF-based orientation. -See [withMetadata](#withMetadata) for control over this. +See [withMetadata](#withmetadata) for control over this. The caller is responsible for ensuring directory structures and permissions exist. @@ -42,12 +42,12 @@ sharp(input) Write output to a Buffer. JPEG, PNG, WebP, AVIF, TIFF, GIF and raw pixel data output are supported. -Use [toFormat](#toFormat) or one of the format-specific functions such as [jpeg](#jpeg), [png](#png) etc. to set the output format. +Use [toFormat](#toformat) or one of the format-specific functions such as [jpeg](#jpeg), [png](#png) etc. to set the output format. If no explicit format is set, the output format will match the input image, except SVG input which becomes PNG output. By default all metadata will be removed, which includes EXIF-based orientation. -See [withMetadata](#withMetadata) for control over this. +See [withMetadata](#withmetadata) for control over this. `callback`, if present, gets three arguments `(err, data, info)` where: - `err` is an error, if any. @@ -373,7 +373,8 @@ await sharp('in.gif', { animated: true }) ## tiff Use these TIFF options for output image. -The `density` can be set in pixels/inch via [withMetadata](#withMetadata) instead of providing `xres` and `yres` in pixels/mm. +The `density` can be set in pixels/inch via [withMetadata](#withmetadata) +instead of providing `xres` and `yres` in pixels/mm. **Throws**: diff --git a/lib/colour.js b/lib/colour.js index 09d2cda9..a7761d29 100644 --- a/lib/colour.js +++ b/lib/colour.js @@ -70,7 +70,8 @@ function grayscale (grayscale) { * Set the pipeline colourspace. * * The input image will be converted to the provided colourspace at the start of the pipeline. - * All operations will use this colourspace before converting to the output colourspace, as defined by {@link toColourspace}. + * All operations will use this colourspace before converting to the output colourspace, + * as defined by {@link #tocolourspace|toColourspace}. * * This feature is experimental and has not yet been fully-tested with all operations. * diff --git a/lib/output.js b/lib/output.js index d9263dfe..426af0b7 100644 --- a/lib/output.js +++ b/lib/output.js @@ -43,7 +43,7 @@ const bitdepthFromColourCount = (colours) => 1 << 31 - Math.clz32(Math.ceil(Math * Note that raw pixel data is only supported for buffer output. * * By default all metadata will be removed, which includes EXIF-based orientation. - * See {@link withMetadata} for control over this. + * See {@link #withmetadata|withMetadata} for control over this. * * The caller is responsible for ensuring directory structures and permissions exist. * @@ -95,12 +95,12 @@ function toFile (fileOut, callback) { * Write output to a Buffer. * JPEG, PNG, WebP, AVIF, TIFF, GIF and raw pixel data output are supported. * - * Use {@link toFormat} or one of the format-specific functions such as {@link jpeg}, {@link png} etc. to set the output format. + * Use {@link #toformat|toFormat} or one of the format-specific functions such as {@link jpeg}, {@link png} etc. to set the output format. * * If no explicit format is set, the output format will match the input image, except SVG input which becomes PNG output. * * By default all metadata will be removed, which includes EXIF-based orientation. - * See {@link withMetadata} for control over this. + * See {@link #withmetadata|withMetadata} for control over this. * * `callback`, if present, gets three arguments `(err, data, info)` where: * - `err` is an error, if any. @@ -740,7 +740,8 @@ function trySetAnimationOptions (source, target) { /** * Use these TIFF options for output image. * - * The `density` can be set in pixels/inch via {@link withMetadata} instead of providing `xres` and `yres` in pixels/mm. + * The `density` can be set in pixels/inch via {@link #withmetadata|withMetadata} + * instead of providing `xres` and `yres` in pixels/mm. * * @example * // Convert SVG input to LZW-compressed, 1 bit per pixel TIFF output