Docs: prebuilt binaries support tile-based output (#4305)

Except when targeting WebAssembly.
This commit is contained in:
Kleis Auke Wolthuizen
2024-12-28 12:51:50 +01:00
committed by GitHub
parent 82dc859a49
commit 92083ea64c
5 changed files with 3 additions and 11 deletions

2
lib/index.d.ts vendored
View File

@@ -799,8 +799,6 @@ declare namespace sharp {
* Use tile-based deep zoom (image pyramid) output.
* Set the format and options for tile images via the toFormat, jpeg, png or webp functions.
* Use a .zip or .szi file extension with toFile to write to a compressed archive file format.
*
* Warning: multiple sharp instances concurrently producing tile output can expose a possible race condition in some versions of libgsf.
* @param tile tile options
* @throws {Error} Invalid options
* @returns A sharp instance that can be used to chain operations

View File

@@ -1232,10 +1232,6 @@ function raw (options) {
*
* The container will be set to `zip` when the output is a Buffer or Stream, otherwise it will default to `fs`.
*
* Requires libvips compiled with support for libgsf.
* The prebuilt binaries do not include this - see
* {@link https://sharp.pixelplumbing.com/install#custom-libvips installing a custom libvips}.
*
* @example
* sharp('input.tiff')
* .png()