Skip to content

Commit

Permalink
Docs: prebuilt binaries support tile-based output (#4305)
Browse files Browse the repository at this point in the history
Except when targeting WebAssembly.
  • Loading branch information
kleisauke authored Dec 28, 2024
1 parent 82dc859 commit 92083ea
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 11 deletions.
4 changes: 0 additions & 4 deletions docs/api-output.md
Original file line number Diff line number Diff line change
Expand Up @@ -762,10 +762,6 @@ Use a `.zip` or `.szi` file extension with `toFile` to write to a compressed arc

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
[installing a custom libvips](https://sharp.pixelplumbing.com/install#custom-libvips).


**Throws**:

Expand Down
2 changes: 2 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,8 @@ Use in web browsers is unsupported.

Native text rendering is unsupported.

[Tile-based output](/api-output#tile) is unsupported.

```sh
npm install --cpu=wasm32 sharp
```
Expand Down
2 changes: 1 addition & 1 deletion docs/search-index.json

Large diffs are not rendered by default.

2 changes: 0 additions & 2 deletions lib/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 0 additions & 4 deletions lib/output.js
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down

0 comments on commit 92083ea

Please sign in to comment.