Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-07-09 18:40:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: tile-based output requires libgsf

Browse Source
This commit is contained in:
Lovell Fuller 2023-03-22 09:17:07 +00:00
parent cd5e11bd50
commit 6008ff8a08
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api-output.md
View File

@ -549,6 +549,10 @@ 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`. 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**: **Throws**:

4
lib/output.js
View File

@ -1056,6 +1056,10 @@ function raw (options) {
* *
* The container will be set to `zip` when the output is a Buffer or Stream, otherwise it will default to `fs`. * 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 * @example
* sharp('input.tiff') * sharp('input.tiff')
* .png() * .png()