Showing preview only (1,454K chars total). Download the full file or copy to clipboard to get everything.
Repository: lovell/sharp
Branch: main
Commit: 7b4c4762432b
Files: 278
Total size: 1.3 MB
Directory structure:
gitextract_pusvgzt3/
├── .cirrus.yml
├── .editorconfig
├── .github/
│ ├── CONTRIBUTING.md
│ ├── FUNDING.yml
│ ├── ISSUE_TEMPLATE/
│ │ ├── config.yml
│ │ ├── feature_request.md
│ │ ├── installation.md
│ │ ├── possible-bug.md
│ │ └── question.md
│ ├── SECURITY.md
│ └── workflows/
│ ├── ci.yml
│ └── npm.yml
├── .gitignore
├── LICENSE
├── README.md
├── biome.json
├── docs/
│ ├── astro.config.mjs
│ ├── build.mjs
│ ├── firebase.json
│ ├── package.json
│ ├── public/
│ │ ├── humans.txt
│ │ └── robots.txt
│ ├── src/
│ │ ├── content/
│ │ │ └── docs/
│ │ │ ├── api-channel.md
│ │ │ ├── api-colour.md
│ │ │ ├── api-composite.md
│ │ │ ├── api-constructor.md
│ │ │ ├── api-input.md
│ │ │ ├── api-operation.md
│ │ │ ├── api-output.md
│ │ │ ├── api-resize.md
│ │ │ ├── api-utility.md
│ │ │ ├── changelog/
│ │ │ │ ├── _meta.yml
│ │ │ │ ├── v0.10.0.md
│ │ │ │ ├── v0.10.1.md
│ │ │ │ ├── v0.11.0.md
│ │ │ │ ├── v0.11.1.md
│ │ │ │ ├── v0.11.2.md
│ │ │ │ ├── v0.11.3.md
│ │ │ │ ├── v0.11.4.md
│ │ │ │ ├── v0.12.0.md
│ │ │ │ ├── v0.12.1.md
│ │ │ │ ├── v0.12.2.md
│ │ │ │ ├── v0.13.0.md
│ │ │ │ ├── v0.13.1.md
│ │ │ │ ├── v0.14.0.md
│ │ │ │ ├── v0.14.1.md
│ │ │ │ ├── v0.15.0.md
│ │ │ │ ├── v0.15.1.md
│ │ │ │ ├── v0.16.0.md
│ │ │ │ ├── v0.16.1.md
│ │ │ │ ├── v0.16.2.md
│ │ │ │ ├── v0.17.0.md
│ │ │ │ ├── v0.17.1.md
│ │ │ │ ├── v0.17.2.md
│ │ │ │ ├── v0.17.3.md
│ │ │ │ ├── v0.18.0.md
│ │ │ │ ├── v0.18.1.md
│ │ │ │ ├── v0.18.2.md
│ │ │ │ ├── v0.18.3.md
│ │ │ │ ├── v0.18.4.md
│ │ │ │ ├── v0.19.0.md
│ │ │ │ ├── v0.19.1.md
│ │ │ │ ├── v0.20.0.md
│ │ │ │ ├── v0.20.1.md
│ │ │ │ ├── v0.20.2.md
│ │ │ │ ├── v0.20.3.md
│ │ │ │ ├── v0.20.4.md
│ │ │ │ ├── v0.20.5.md
│ │ │ │ ├── v0.20.6.md
│ │ │ │ ├── v0.20.7.md
│ │ │ │ ├── v0.20.8.md
│ │ │ │ ├── v0.21.0.md
│ │ │ │ ├── v0.21.1.md
│ │ │ │ ├── v0.21.2.md
│ │ │ │ ├── v0.21.3.md
│ │ │ │ ├── v0.22.0.md
│ │ │ │ ├── v0.22.1.md
│ │ │ │ ├── v0.23.0.md
│ │ │ │ ├── v0.23.1.md
│ │ │ │ ├── v0.23.2.md
│ │ │ │ ├── v0.23.3.md
│ │ │ │ ├── v0.23.4.md
│ │ │ │ ├── v0.24.0.md
│ │ │ │ ├── v0.24.1.md
│ │ │ │ ├── v0.25.0.md
│ │ │ │ ├── v0.25.1.md
│ │ │ │ ├── v0.25.2.md
│ │ │ │ ├── v0.25.3.md
│ │ │ │ ├── v0.25.4.md
│ │ │ │ ├── v0.26.0.md
│ │ │ │ ├── v0.26.1.md
│ │ │ │ ├── v0.26.2.md
│ │ │ │ ├── v0.26.3.md
│ │ │ │ ├── v0.27.0.md
│ │ │ │ ├── v0.27.1.md
│ │ │ │ ├── v0.27.2.md
│ │ │ │ ├── v0.28.0.md
│ │ │ │ ├── v0.28.1.md
│ │ │ │ ├── v0.28.2.md
│ │ │ │ ├── v0.28.3.md
│ │ │ │ ├── v0.29.0.md
│ │ │ │ ├── v0.29.1.md
│ │ │ │ ├── v0.29.2.md
│ │ │ │ ├── v0.29.3.md
│ │ │ │ ├── v0.30.0.md
│ │ │ │ ├── v0.30.1.md
│ │ │ │ ├── v0.30.2.md
│ │ │ │ ├── v0.30.3.md
│ │ │ │ ├── v0.30.4.md
│ │ │ │ ├── v0.30.5.md
│ │ │ │ ├── v0.30.6.md
│ │ │ │ ├── v0.30.7.md
│ │ │ │ ├── v0.31.0.md
│ │ │ │ ├── v0.31.1.md
│ │ │ │ ├── v0.31.2.md
│ │ │ │ ├── v0.31.3.md
│ │ │ │ ├── v0.32.0.md
│ │ │ │ ├── v0.32.1.md
│ │ │ │ ├── v0.32.2.md
│ │ │ │ ├── v0.32.3.md
│ │ │ │ ├── v0.32.4.md
│ │ │ │ ├── v0.32.5.md
│ │ │ │ ├── v0.32.6.md
│ │ │ │ ├── v0.33.0.md
│ │ │ │ ├── v0.33.1.md
│ │ │ │ ├── v0.33.2.md
│ │ │ │ ├── v0.33.3.md
│ │ │ │ ├── v0.33.4.md
│ │ │ │ ├── v0.33.5.md
│ │ │ │ ├── v0.34.0.md
│ │ │ │ ├── v0.34.1.md
│ │ │ │ ├── v0.34.2.md
│ │ │ │ ├── v0.34.3.md
│ │ │ │ ├── v0.34.4.md
│ │ │ │ └── v0.34.5.md
│ │ │ ├── index.md
│ │ │ ├── install.md
│ │ │ └── performance.md
│ │ ├── content.config.ts
│ │ └── styles/
│ │ └── custom.css
│ └── tsconfig.json
├── install/
│ ├── build.js
│ └── check.js
├── lib/
│ ├── channel.js
│ ├── colour.js
│ ├── composite.js
│ ├── constructor.js
│ ├── index.d.ts
│ ├── index.js
│ ├── input.js
│ ├── is.js
│ ├── libvips.js
│ ├── operation.js
│ ├── output.js
│ ├── resize.js
│ ├── sharp.js
│ └── utility.js
├── npm/
│ ├── darwin-arm64/
│ │ └── package.json
│ ├── darwin-x64/
│ │ └── package.json
│ ├── from-local-build.js
│ ├── linux-arm/
│ │ └── package.json
│ ├── linux-arm64/
│ │ └── package.json
│ ├── linux-ppc64/
│ │ └── package.json
│ ├── linux-riscv64/
│ │ └── package.json
│ ├── linux-s390x/
│ │ └── package.json
│ ├── linux-x64/
│ │ └── package.json
│ ├── linuxmusl-arm64/
│ │ └── package.json
│ ├── linuxmusl-x64/
│ │ └── package.json
│ ├── package.json
│ ├── release-notes.js
│ ├── wasm32/
│ │ └── package.json
│ ├── win32-arm64/
│ │ └── package.json
│ ├── win32-ia32/
│ │ └── package.json
│ └── win32-x64/
│ └── package.json
├── package.json
├── src/
│ ├── CPPLINT.cfg
│ ├── binding.gyp
│ ├── common.cc
│ ├── common.h
│ ├── emscripten/
│ │ ├── common.gypi
│ │ └── pre.js
│ ├── metadata.cc
│ ├── metadata.h
│ ├── operations.cc
│ ├── operations.h
│ ├── pipeline.cc
│ ├── pipeline.h
│ ├── sharp.cc
│ ├── stats.cc
│ ├── stats.h
│ ├── utilities.cc
│ └── utilities.h
└── test/
├── bench/
│ ├── Dockerfile
│ ├── package.json
│ ├── parallel.js
│ ├── perf.js
│ ├── random.js
│ └── run-with-docker.sh
├── fixtures/
│ ├── 8bit_depth.tiff
│ ├── G31D.TIF
│ ├── G31D_MULTI.TIF
│ ├── XCMYK 2017.icc
│ ├── bonne.geo.tif
│ ├── cielab-dagams.tiff
│ ├── expected/
│ │ ├── colourspace.cmyk-to-cmyk-negated.tif
│ │ └── extract.tiff
│ ├── fogra-0-100-100-0.tif
│ ├── hilutite.icm
│ ├── index.js
│ ├── invalid-illuminant.icc
│ ├── relax.jp2
│ ├── relax_tileparts.jp2
│ ├── sdr_cosmos12920_cicp1-13-6_yuv444_full_qp10.avif
│ ├── tifftag-photoshop.tiff
│ ├── uncompressed_tiff.tiff
│ └── vfile.v
├── leak/
│ ├── leak.sh
│ └── sharp.supp
├── types/
│ ├── sharp.test-d.ts
│ └── tsconfig.json
├── unit/
│ ├── affine.js
│ ├── alpha.js
│ ├── avif.js
│ ├── bandbool.js
│ ├── blur.js
│ ├── boolean.js
│ ├── clahe.js
│ ├── clone.js
│ ├── colourspace.js
│ ├── composite.js
│ ├── convolve.js
│ ├── dilate.js
│ ├── erode.js
│ ├── extend.js
│ ├── extract.js
│ ├── extractChannel.js
│ ├── failOn.js
│ ├── fixtures.js
│ ├── gamma.js
│ ├── gif.js
│ ├── heif.js
│ ├── io.js
│ ├── join.js
│ ├── joinChannel.js
│ ├── jp2.js
│ ├── jpeg.js
│ ├── jxl.js
│ ├── libvips.js
│ ├── linear.js
│ ├── median.js
│ ├── metadata.js
│ ├── modulate.js
│ ├── negate.js
│ ├── noise.js
│ ├── normalize.js
│ ├── png.js
│ ├── raw.js
│ ├── recomb.js
│ ├── resize-contain.js
│ ├── resize-cover.js
│ ├── resize.js
│ ├── rotate.js
│ ├── sharpen.js
│ ├── stats.js
│ ├── svg.js
│ ├── text.js
│ ├── threshold.js
│ ├── tiff.js
│ ├── tile.js
│ ├── timeout.js
│ ├── tint.js
│ ├── toBuffer.js
│ ├── toFormat.js
│ ├── trim.js
│ ├── unflatten.js
│ ├── util.js
│ └── webp.js
└── unit.mjs
================================================
FILE CONTENTS
================================================
================================================
FILE: .cirrus.yml
================================================
freebsd_instance:
image_family: freebsd-16-0-snap
task:
name: FreeBSD
env:
IGNORE_OSVERSION: yes
skip_notifications: true
prerequisites_script:
- pkg update -f
- pkg upgrade -y
- pkg install -y devel/git devel/pkgconf graphics/vips www/node22 www/npm
- pkg-config --modversion vips-cpp
install_script:
- npm install
- npm run build
test_script:
- node --test test/unit/io.js
================================================
FILE: .editorconfig
================================================
# http://editorconfig.org
root = true
[*]
indent_style = space
indent_size = 2
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
max_line_length = 120
================================================
FILE: .github/CONTRIBUTING.md
================================================
# Contributing to sharp
Hello, thank you for your interest in helping!
## Submit a new bug report
Please create a [new issue](https://github.com/lovell/sharp/issues/new) containing the steps to reproduce the problem.
New bugs are assigned a `triage` label whilst under investigation.
## Submit a new feature request
If a [similar request](https://github.com/lovell/sharp/labels/enhancement) exists,
it's probably fastest to add a comment to it about your requirement.
Implementation is usually straightforward if libvips
[already supports](https://www.libvips.org/API/current/function-list.html)
the feature you need.
## Submit a Pull Request to fix a bug
Thank you! To prevent the problem occurring again, please add unit tests that would have failed.
Please select the `main` branch as the destination for your Pull Request so your fix can be included in the next minor release.
Please squash your changes into a single commit using a command like `git rebase -i upstream/main`.
To test C++ changes, you can compile the module using `npm run build` and then run the tests using `npm test`.
## Submit a Pull Request with a new feature
Please add JavaScript [unit tests](https://github.com/lovell/sharp/tree/main/test/unit) to cover your new feature.
Please also update the [TypeScript definitions](https://github.com/lovell/sharp/tree/main/lib/index.d.ts), along with the [type definition tests](https://github.com/lovell/sharp/tree/main/test/types/sharp.test-d.ts).
Where possible, the functional tests use gradient-based perceptual hashes
based on [dHash](http://www.hackerfactor.com/blog/index.php?/archives/529-Kind-of-Like-That.html)
to compare expected vs actual images.
You deserve to add your details to the [list of contributors](https://github.com/lovell/sharp/blob/main/package.json#L5).
Any change that modifies the existing public API should be added to the relevant work-in-progress branch for inclusion in the next major release.
Please squash your changes into a single commit using a command like `git rebase -i upstream/<wip-branch>`.
### Add a new public method
The API tries to be as fluent as possible.
Image processing concepts follow the naming conventions from libvips and, to a lesser extent, ImageMagick.
Most methods have optional parameters and assume sensible defaults.
Please ensure backwards compatibility where possible.
Feel free to create a [new issue](https://github.com/lovell/sharp/issues/new) to gather feedback on a potential API change.
### Remove an existing public method
A method to be removed should be deprecated in the next major version then removed in the following major version.
By way of example, the `background()` method present in v0.20.0 was deprecated in v0.21.0 and removed in v0.22.0.
## Documentation
The public API is documented with [JSDoc](https://jsdoc.app/) annotated comments.
These can be converted to Markdown by running:
```sh
npm run docs-build
```
Please include documentation updates in any Pull Request that modifies the public API.
## Run the tests
### Functional tests and static code analysis
```sh
npm test
```
### Memory leak tests
Requires [Valgrind](http://valgrind.org/).
```sh
npm run test-leak
```
## Finally
Please feel free to ask any questions via a
[new issue](https://github.com/lovell/sharp/issues/new).
If you're unable to post details publicly, please
[e-mail](https://github.com/lovell/sharp/blob/main/package.json#L5)
for private, paid consulting.
================================================
FILE: .github/FUNDING.yml
================================================
open_collective: libvips
================================================
FILE: .github/ISSUE_TEMPLATE/config.yml
================================================
blank_issues_enabled: false
contact_links:
- name: Documentation
url: https://sharp.pixelplumbing.com/
about: Installation instructions, complete API documentation with examples, changelog
================================================
FILE: .github/ISSUE_TEMPLATE/feature_request.md
================================================
---
name: Feature request
about: Suggest an idea
labels: enhancement
---
## Feature request
### What are you trying to achieve?
<!-- Please provide context here. -->
### When you searched for similar feature requests, what did you find that might be related?
<!-- Please demonstrate your research here. -->
### What would you expect the API to look like?
<!-- Please provide your suggestions here. -->
### What alternatives have you considered?
<!-- Please provide your ideas here. -->
### Please provide sample image(s) that help explain this feature
<!-- Please provide links to one or more images here. -->
================================================
FILE: .github/ISSUE_TEMPLATE/installation.md
================================================
---
name: Installation
about: Something went wrong during either 'npm install sharp' or 'require("sharp")'
labels: installation
---
<!-- Please try to answer as many of these questions as possible. -->
## Possible install-time or require-time problem
<!-- Please place an [x] in the box to confirm. -->
- [ ] I have read and understood all of the [documentation relating to installation](https://sharp.pixelplumbing.com/install).
- [ ] I have searched for known bugs relating to this problem in my choice of package manager.
You must confirm both of these before continuing.
### Are you using the latest version of sharp?
<!-- Please place an [x] in the box to confirm. -->
- [ ] I am using the latest version of `sharp` as reported by `npm view sharp dist-tags.latest`.
If you cannot confirm this, please upgrade to the latest version and try again before opening an issue.
If you are using another package which depends on a version of `sharp` that is not the latest,
please open an issue against that package instead.
### Are you using a supported runtime?
<!-- Please place an [x] in the relevant box to confirm. -->
- [ ] I am using Node.js with a version that satisfies `^18.17.0 || ^20.3.0 || >=21.0.0`
- [ ] I am using Deno
- [ ] I am using Bun
If you cannot confirm any of these,
please upgrade to the latest version
and try again before opening an issue.
### Are you using a supported package manager and installing optional dependencies?
<!-- Please place an [x] in the relevant box to confirm. -->
- [ ] I am using npm >= 10.1.0 with `--include=optional`
- [ ] I am using yarn >= 3.2.0
- [ ] I am using pnpm >= 7.1.0 with `--no-optional=false`
- [ ] I am using Deno
- [ ] I am using Bun
If you cannot confirm any of these, please upgrade to the latest version of your chosen package manager
and ensure you are allowing the installation of optional or multi-platform dependencies before opening an issue.
### What is the complete error message, including the full stack trace?
<!-- Please provide the error message and stack trace here. -->
### What is the complete output of running `npm install --verbose --foreground-scripts sharp` in an empty directory?
<details>
<!-- Please provide output of `npm install --verbose --foreground-scripts sharp` in an empty directory here. -->
</details>
### What is the output of running `npx envinfo --binaries --system --npmPackages=sharp --npmGlobalPackages=sharp`?
<!-- Please provide output of `npx envinfo --binaries --system --npmPackages=sharp --npmGlobalPackages=sharp` here. -->
================================================
FILE: .github/ISSUE_TEMPLATE/possible-bug.md
================================================
---
name: Possible bug
about: Installation of sharp was successful but then something unexpected occurred using one of its features
labels: triage
---
<!-- If this issue relates to installation, please use https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md instead. -->
## Possible bug
### Is this a possible bug in a feature of sharp, unrelated to installation?
<!-- Please place an [x] in the box to confirm. -->
- [ ] Running `npm install sharp` completes without error.
- [ ] Running `node -e "require('sharp')"` completes without error.
If you cannot confirm both of these, please open an [installation issue](https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md) instead.
### Are you using the latest version of sharp?
<!-- Please place an [x] in the box to confirm. -->
- [ ] I am using the latest version of `sharp` as reported by `npm view sharp dist-tags.latest`.
If you cannot confirm this, please upgrade to the latest version and try again before opening an issue.
If you are using another package which depends on a version of `sharp` that is not the latest, please open an issue against that package instead.
### What is the output of running `npx envinfo --binaries --system --npmPackages=sharp --npmGlobalPackages=sharp`?
<!-- Please provide output of the above command here. -->
### Does this problem relate to file caching?
The default behaviour of libvips is to cache input files, which can lead to `EBUSY` or `EPERM` errors on Windows.
Use [`sharp.cache(false)`](https://sharp.pixelplumbing.com/api-utility#cache) to switch this feature off.
- [ ] Adding `sharp.cache(false)` does not fix this problem.
### Does this problem relate to images appearing to have been rotated by 90 degrees?
Images that contain EXIF Orientation metadata are not auto-oriented. By default, EXIF metadata is removed.
- To auto-orient pixel values use the parameter-less [`rotate()`](https://sharp.pixelplumbing.com/api-operation#rotate) operation.
- To retain EXIF Orientation use [`keepExif()`](https://sharp.pixelplumbing.com/api-output#keepexif).
- [ ] Using `rotate()` or `keepExif()` does not fix this problem.
### What are the steps to reproduce?
<!-- Please enter steps to reproduce here. -->
### What is the expected behaviour?
<!-- Please enter the expected behaviour here. -->
### Please provide a minimal, standalone code sample, without other dependencies, that demonstrates this problem
<!-- Please provide either formatted code or a link to a repo/gist that allows someone else to reproduce here. -->
### Please provide sample image(s) that help explain this problem
<!-- Please provide links to one or more images here. -->
================================================
FILE: .github/ISSUE_TEMPLATE/question.md
================================================
---
name: Question
about: For help understanding an existing feature
labels: question
---
<!-- If this issue relates to installation, please use https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md instead. -->
## Question about an existing feature
### What are you trying to achieve?
<!-- Please provide context here. -->
### When you searched for similar issues, what did you find that might be related?
<!-- Please demonstrate your research here. -->
### Please provide a minimal, standalone code sample, without other dependencies, that demonstrates this question
<!-- Please provide either formatted code or a link to a repo/gist that helps someone else understand here. -->
### Please provide sample image(s) that help explain this question
<!-- Please provide links to one or more images here. -->
================================================
FILE: .github/SECURITY.md
================================================
# Security Policy
## Supported Versions
The latest version of `sharp` as published to npm
and reported by `npm view sharp dist-tags.latest`
is supported with security updates.
## Reporting a Vulnerability
Please use
[e-mail](https://github.com/lovell/sharp/blob/main/package.json#L5)
to report a vulnerability.
You can expect a response within 48 hours
if you are a human reporting a genuine issue.
Thank you in advance.
================================================
FILE: .github/workflows/ci.yml
================================================
name: CI
on:
- push
- pull_request
permissions: {}
jobs:
lint:
permissions:
contents: read
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v5
with:
node-version: "24"
- run: npm install --ignore-scripts
- run: npm run lint-cpp
- run: npm run lint-js
- run: npm run lint-types
build-native:
permissions:
contents: read
needs: lint
name: "build-${{ matrix.platform }} [Node.js ${{ matrix.nodejs_version_major }}] ${{ matrix.package && '[package]' }}"
runs-on: ${{ matrix.os }}
container: ${{ matrix.container }}
strategy:
fail-fast: false
matrix:
include:
- os: ubuntu-24.04
container: rockylinux:8
nodejs_arch: x64
nodejs_version: "^18.17.0"
nodejs_version_major: 18
platform: linux-x64
package: true
- os: ubuntu-24.04
container: rockylinux:8
nodejs_arch: x64
nodejs_version: "^20.3.0"
nodejs_version_major: 20
platform: linux-x64
- os: ubuntu-24.04
container: rockylinux:8
nodejs_arch: x64
nodejs_version: "^22.9.0"
nodejs_version_major: 22
platform: linux-x64
- os: ubuntu-24.04
container: node:18-alpine3.17
nodejs_version_major: 18
platform: linuxmusl-x64
package: true
- os: ubuntu-24.04
container: node:20-alpine3.18
nodejs_version_major: 20
platform: linuxmusl-x64
- os: ubuntu-24.04
container: node:22-alpine3.20
nodejs_version_major: 22
platform: linuxmusl-x64
- os: ubuntu-24.04-arm
container: arm64v8/rockylinux:8
nodejs_arch: arm64
nodejs_version: "^18.17.0"
nodejs_version_major: 18
platform: linux-arm64
package: true
- os: ubuntu-24.04-arm
container: arm64v8/rockylinux:8
nodejs_arch: arm64
nodejs_version: "^20.3.0"
nodejs_version_major: 20
platform: linux-arm64
- os: macos-15-intel
nodejs_arch: x64
nodejs_version: "^18.17.0"
nodejs_version_major: 18
platform: darwin-x64
package: true
- os: macos-15-intel
nodejs_arch: x64
nodejs_version: "^20.3.0"
nodejs_version_major: 20
platform: darwin-x64
- os: macos-15-intel
nodejs_arch: x64
nodejs_version: "^22.9.0"
nodejs_version_major: 22
platform: darwin-x64
- os: macos-15
nodejs_arch: arm64
nodejs_version: "^18.17.0"
nodejs_version_major: 18
platform: darwin-arm64
package: true
- os: macos-15
nodejs_arch: arm64
nodejs_version: "^20.3.0"
nodejs_version_major: 20
platform: darwin-arm64
- os: macos-15
nodejs_arch: arm64
nodejs_version: "^22.9.0"
nodejs_version_major: 22
platform: darwin-arm64
- os: windows-2022
nodejs_arch: x86
nodejs_version: "18.18.2" # pinned to avoid 18.19.0 and npm 10
nodejs_version_major: 18
platform: win32-ia32
package: true
- os: windows-2022
nodejs_arch: x86
nodejs_version: "^20.3.0"
nodejs_version_major: 20
platform: win32-ia32
- os: windows-2022
nodejs_arch: x86
nodejs_version: "^22.9.0"
nodejs_version_major: 22
platform: win32-ia32
- os: windows-2022
nodejs_arch: x64
nodejs_version: "^18.17.0"
nodejs_version_major: 18
platform: win32-x64
package: true
- os: windows-2022
nodejs_arch: x64
nodejs_version: "^20.3.0"
nodejs_version_major: 20
platform: win32-x64
- os: windows-2022
nodejs_arch: x64
nodejs_version: "^22.9.0"
nodejs_version_major: 22
platform: win32-x64
- os: windows-11-arm
nodejs_arch: arm64
nodejs_version: "^20.3.0"
nodejs_version_major: 20
platform: win32-arm64
package: true
- os: windows-11-arm
nodejs_arch: arm64
nodejs_version: "^22.9.0"
nodejs_version_major: 22
platform: win32-arm64
steps:
- name: Dependencies (Rocky Linux glibc)
if: contains(matrix.container, 'rockylinux')
run: |
dnf install -y gcc-toolset-14-gcc-c++ make git python3.12 fontconfig google-noto-sans-fonts
echo "/opt/rh/gcc-toolset-14/root/usr/bin" >> $GITHUB_PATH
- name: Dependencies (Linux musl)
if: contains(matrix.container, 'alpine')
run: apk add build-base git python3 font-noto --update-cache
- name: Dependencies (Python 3.11 - macOS, Windows)
if: contains(matrix.os, 'macos') || contains(matrix.os, 'windows')
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Dependencies (Node.js)
if: "!contains(matrix.platform, 'linuxmusl')"
uses: actions/setup-node@v5
with:
node-version: ${{ matrix.nodejs_version }}
architecture: ${{ matrix.nodejs_arch }}
- uses: actions/checkout@v4
- run: npm install
- run: npm run build
- run: npm run test-unit
- if: matrix.package
run: npm run package-from-local-build
- uses: actions/upload-artifact@v4
if: matrix.package
with:
name: ${{ matrix.platform }}
path: npm/${{ matrix.platform }}
retention-days: 1
if-no-files-found: error
build-linuxmusl-arm64:
permissions:
contents: read
needs: lint
name: "build-linuxmusl-arm64 [Node.js ${{ matrix.nodejs_version_major }}] ${{ matrix.package && '[package]' }}"
runs-on: ubuntu-24.04-arm
container:
image: ${{ matrix.container }}
volumes:
- /opt:/opt:rw,rshared
- /opt:/__e/node20:ro,rshared
strategy:
fail-fast: false
matrix:
include:
- container: node:18-alpine3.17
nodejs_version_major: 18
package: true
- container: node:20-alpine3.18
nodejs_version_major: 20
steps:
- name: Allow Linux musl containers on ARM64 runners # https://github.com/actions/runner/issues/801#issuecomment-2394425757
shell: sh
run: |
sed -i "/^ID=/s/alpine/NotpineForGHA/" /etc/os-release
apk add nodejs --update-cache
mkdir /opt/bin
ln -s /usr/bin/node /opt/bin/node
- name: Dependencies
run: apk add build-base git python3 font-noto --update-cache
- uses: actions/checkout@v4
- run: npm install
- run: npm run build
- run: npm run test-unit
- if: matrix.package
run: npm run package-from-local-build
- uses: actions/upload-artifact@v4
if: matrix.package
with:
name: linuxmusl-arm64
path: npm/linuxmusl-arm64
retention-days: 1
if-no-files-found: error
build-qemu:
permissions:
contents: read
needs: lint
name: "build-${{ matrix.platform }} [Node.js ${{ matrix.nodejs_version_major }}] [package]"
runs-on: ubuntu-24.04
strategy:
fail-fast: false
matrix:
include:
- platform: linux-arm
base_image: "balenalib/rpi-raspbian:bullseye"
nodejs_arch: armv6l
nodejs_hostname: unofficial-builds.nodejs.org
nodejs_version: "18.17.0"
nodejs_version_major: 18
- platform: linux-s390x
base_image: "--platform=linux/s390x s390x/debian:bookworm"
nodejs_arch: s390x
nodejs_hostname: nodejs.org
nodejs_version: "18.17.0"
nodejs_version_major: 18
- platform: linux-ppc64
base_image: "--platform=linux/ppc64le ppc64le/debian:bookworm"
nodejs_arch: ppc64le
nodejs_hostname: nodejs.org
nodejs_version: "18.17.0"
nodejs_version_major: 18
- platform: linux-riscv64
base_image: "--platform=linux/riscv64 riscv64/debian:trixie"
compiler_flags: "-march=rv64gc"
nodejs_arch: riscv64
nodejs_hostname: unofficial-builds.nodejs.org
nodejs_version: "20.19.5"
nodejs_version_major: 20
steps:
- uses: actions/checkout@v4
- uses: uraimo/run-on-arch-action@v3
with:
arch: none
distro: none
base_image: ${{ matrix.base_image }}
env: |
CFLAGS: "${{ matrix.compiler_flags }}"
CXXFLAGS: "${{ matrix.compiler_flags }}"
run: |
apt-get update
apt-get install -y curl g++ git libatomic1 make python3 xz-utils
mkdir /opt/nodejs
curl --silent https://${{ matrix.nodejs_hostname }}/download/release/v${{ matrix.nodejs_version}}/node-v${{ matrix.nodejs_version}}-linux-${{ matrix.nodejs_arch }}.tar.xz | tar xJC /opt/nodejs --strip-components=1
export PATH=$PATH:/opt/nodejs/bin
npm install
npm run build
node --test test/unit/io.js
npm run package-from-local-build
- uses: actions/upload-artifact@v4
with:
name: ${{ matrix.platform }}
path: npm/${{ matrix.platform }}
retention-days: 1
if-no-files-found: error
build-emscripten:
permissions:
contents: read
needs: lint
name: "build-wasm32 [package]"
runs-on: ubuntu-24.04
container: "emscripten/emsdk:4.0.18"
steps:
- uses: actions/checkout@v4
- name: Dependencies
run: apt-get update && apt-get install -y pkg-config
- name: Dependencies (Node.js)
uses: actions/setup-node@v5
with:
node-version: "20"
- run: npm install
- run: emmake npm run build
- name: Verify emscripten versions match
run: |
EMSCRIPTEN_VERSION_LIBVIPS=$(node -p "require('@img/sharp-libvips-dev-wasm32/versions').emscripten")
EMSCRIPTEN_VERSION_SHARP=$(emcc -dumpversion)
echo "libvips built with emscripten $EMSCRIPTEN_VERSION_LIBVIPS"
echo "sharp built with emscripten $EMSCRIPTEN_VERSION_SHARP"
test "$EMSCRIPTEN_VERSION_LIBVIPS" = "$EMSCRIPTEN_VERSION_SHARP"
- run: emmake npm run test-unit
- run: emmake npm run package-from-local-build
- uses: actions/upload-artifact@v4
with:
name: wasm32
path: npm/wasm32
retention-days: 1
if-no-files-found: error
release:
permissions:
contents: write
id-token: write
runs-on: ubuntu-24.04
needs:
- build-native
- build-linuxmusl-arm64
- build-qemu
- build-emscripten
steps:
- uses: actions/checkout@v4
- uses: actions/download-artifact@v4
with:
path: npm
- name: Create npm workspace tarball
run: tar -vcaf npm-workspace.tar.xz --directory npm --exclude=from-local-build.js .
- uses: actions/setup-node@v5
with:
node-version: '24'
- name: Create release notes
run: npm run package-release-notes
- name: Create GitHub release for tag
if: startsWith(github.ref, 'refs/tags/v')
uses: ncipollo/release-action@v1
with:
artifacts: npm-workspace.tar.xz
artifactContentType: application/x-xz
prerelease: ${{ contains(github.ref, '-rc') }}
makeLatest: ${{ !contains(github.ref, '-rc') }}
bodyFile: release-notes.md
- name: Publish platform-specific npm packages
if: startsWith(github.ref, 'refs/tags/v')
run: cd npm && npm publish --workspaces --tag=${{ contains(github.ref, '-rc') && 'next' || 'latest' }}
- name: Publish sharp npm package
if: startsWith(github.ref, 'refs/tags/v')
run: npm publish --tag=${{ contains(github.ref, '-rc') && 'next' || 'latest' }}
================================================
FILE: .github/workflows/npm.yml
================================================
name: "CI: npm smoke test"
on:
push:
tags:
- "v**"
permissions: {}
jobs:
release-smoke-test:
name: "${{ github.ref_name }} ${{ matrix.name }}"
runs-on: ${{ matrix.runs-on }}
strategy:
fail-fast: false
matrix:
include:
- name: linux-x64-node-npm
runs-on: ubuntu-24.04
runtime: node
package-manager: npm
- name: linux-x64-node-pnpm
runs-on: ubuntu-24.04
runtime: node
package-manager: pnpm
- name: linux-x64-node-yarn
runs-on: ubuntu-24.04
runtime: node
package-manager: yarn
- name: linux-x64-node-yarn-pnp
runs-on: ubuntu-24.04
runtime: node
package-manager: yarn-pnp
- name: linux-x64-node-yarn-v1
runs-on: ubuntu-24.04
runtime: node
package-manager: yarn-v1
- name: linux-x64-deno
runs-on: ubuntu-24.04
runtime: deno
- name: linux-x64-bun
runs-on: ubuntu-24.04
runtime: bun
- name: darwin-x64-node-npm
runs-on: macos-15-intel
runtime: node
package-manager: npm
- name: darwin-x64-node-pnpm
runs-on: macos-15-intel
runtime: node
package-manager: pnpm
- name: darwin-x64-node-yarn
runs-on: macos-15-intel
runtime: node
package-manager: yarn
- name: darwin-x64-node-yarn-pnp
runs-on: macos-15-intel
runtime: node
package-manager: yarn-pnp
- name: darwin-x64-node-yarn-v1
runs-on: macos-15-intel
runtime: node
package-manager: yarn-v1
- name: darwin-x64-deno
runs-on: macos-15-intel
runtime: deno
- name: darwin-x64-bun
runs-on: macos-15-intel
runtime: bun
- name: win32-x64-node-npm
runs-on: windows-2022
runtime: node
package-manager: npm
- name: win32-x64-node-pnpm
runs-on: windows-2022
runtime: node
package-manager: pnpm
- name: win32-x64-node-yarn
runs-on: windows-2022
runtime: node
package-manager: yarn
- name: win32-x64-node-yarn-pnp
runs-on: windows-2022
runtime: node
package-manager: yarn-pnp
- name: win32-x64-node-yarn-v1
runs-on: windows-2022
runtime: node
package-manager: yarn-v1
- name: win32-x64-deno
runs-on: windows-2022
runtime: deno
steps:
- name: Install Node.js
if: ${{ matrix.runtime == 'node' }}
uses: actions/setup-node@v5
with:
node-version: 20
- name: Install pnpm
if: ${{ matrix.package-manager == 'pnpm' }}
uses: pnpm/action-setup@v4
with:
version: 8
- name: Install Deno
if: ${{ matrix.runtime == 'deno' }}
uses: denoland/setup-deno@v2
with:
deno-version: v2.x
- name: Install Bun
if: ${{ matrix.runtime == 'bun' }}
uses: oven-sh/setup-bun@v2
with:
bun-version: latest
- name: Version
id: version
uses: actions/github-script@v8
with:
script: |
core.setOutput('semver', context.ref.replace('refs/tags/v',''))
- name: Create package.json
uses: DamianReeves/write-file-action@v1.3
with:
path: package.json
contents: |
{
"dependencies": {
"sharp": "${{ steps.version.outputs.semver }}"
},
"type": "module"
}
- name: Create release.mjs
uses: DamianReeves/write-file-action@v1.3
with:
path: release.mjs
contents: |
import { deepStrictEqual } from 'node:assert';
import sharp from 'sharp';
deepStrictEqual(['.jpg', '.jpeg', '.jpe', '.jfif'], sharp.format.jpeg.input.fileSuffix);
- name: Run with Node.js + npm
if: ${{ matrix.package-manager == 'npm' }}
run: |
npm install --ignore-scripts
node release.mjs
- name: Run with Node.js + pnpm
if: ${{ matrix.package-manager == 'pnpm' }}
run: |
pnpm install --ignore-scripts
node release.mjs
- name: Run with Node.js + yarn
if: ${{ matrix.package-manager == 'yarn' }}
run: |
corepack enable
yarn set version stable
yarn config set enableImmutableInstalls false
yarn config set enableScripts false
yarn config set nodeLinker node-modules
yarn install
node release.mjs
- name: Run with Node.js + yarn pnp
if: ${{ matrix.package-manager == 'yarn-pnp' }}
run: |
corepack enable
yarn set version stable
yarn config set enableImmutableInstalls false
yarn config set enableScripts false
yarn config set nodeLinker pnp
yarn install
yarn node release.mjs
- name: Run with Node.js + yarn v1
if: ${{ matrix.package-manager == 'yarn-v1' }}
run: |
corepack enable
yarn set version classic
yarn install
node release.mjs
- name: Run with Deno
if: ${{ matrix.runtime == 'deno' }}
run: |
deno install
deno run --allow-env --allow-ffi --allow-read --allow-sys release.mjs
- name: Run with Bun
if: ${{ matrix.runtime == 'bun' }}
run: |
bun install --ignore-scripts
bun release.mjs
================================================
FILE: .gitignore
================================================
src/build
src/node_modules
node_modules
/coverage
npm/*/*
!npm/*/package.json
test/bench/node_modules
test/fixtures/output*
test/fixtures/vips-properties.xml
test/leak/libvips.supp
.DS_Store
.nyc_output
.vscode/
package-lock.json
.idea
.firebase
.astro
docs/dist
release-notes.md
================================================
FILE: LICENSE
================================================
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and
distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright
owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities
that control, are controlled by, or are under common control with that entity.
For the purposes of this definition, "control" means (i) the power, direct or
indirect, to cause the direction or management of such entity, whether by
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising
permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including
but not limited to software source code, documentation source, and configuration
files.
"Object" form shall mean any form resulting from mechanical transformation or
translation of a Source form, including but not limited to compiled object code,
generated documentation, and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made
available under the License, as indicated by a copyright notice that is included
in or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that
is based on (or derived from) the Work and for which the editorial revisions,
annotations, elaborations, or other modifications represent, as a whole, an
original work of authorship. For the purposes of this License, Derivative Works
shall not include works that remain separable from, or merely link (or bind by
name) to the interfaces of, the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version
of the Work and any modifications or additions to that Work or Derivative Works
thereof, that is intentionally submitted to Licensor for inclusion in the Work
by the copyright owner or by an individual or Legal Entity authorized to submit
on behalf of the copyright owner. For the purposes of this definition,
"submitted" means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems, and
issue tracking systems that are managed by, or on behalf of, the Licensor for
the purpose of discussing and improving the Work, but excluding communication
that is conspicuously marked or otherwise designated in writing by the copyright
owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
of whom a Contribution has been received by Licensor and subsequently
incorporated within the Work.
2. Grant of Copyright License.
Subject to the terms and conditions of this License, each Contributor hereby
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
irrevocable copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the Work and such
Derivative Works in Source or Object form.
3. Grant of Patent License.
Subject to the terms and conditions of this License, each Contributor hereby
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
irrevocable (except as stated in this section) patent license to make, have
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
such license applies only to those patent claims licensable by such Contributor
that are necessarily infringed by their Contribution(s) alone or by combination
of their Contribution(s) with the Work to which such Contribution(s) was
submitted. If You institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
Contribution incorporated within the Work constitutes direct or contributory
patent infringement, then any patent licenses granted to You under this License
for that Work shall terminate as of the date such litigation is filed.
4. Redistribution.
You may reproduce and distribute copies of the Work or Derivative Works thereof
in any medium, with or without modifications, and in Source or Object form,
provided that You meet the following conditions:
You must give any other recipients of the Work or Derivative Works a copy of
this License; and
You must cause any modified files to carry prominent notices stating that You
changed the files; and
You must retain, in the Source form of any Derivative Works that You distribute,
all copyright, patent, trademark, and attribution notices from the Source form
of the Work, excluding those notices that do not pertain to any part of the
Derivative Works; and
If the Work includes a "NOTICE" text file as part of its distribution, then any
Derivative Works that You distribute must include a readable copy of the
attribution notices contained within such NOTICE file, excluding those notices
that do not pertain to any part of the Derivative Works, in at least one of the
following places: within a NOTICE text file distributed as part of the
Derivative Works; within the Source form or documentation, if provided along
with the Derivative Works; or, within a display generated by the Derivative
Works, if and wherever such third-party notices normally appear. The contents of
the NOTICE file are for informational purposes only and do not modify the
License. You may add Your own attribution notices within Derivative Works that
You distribute, alongside or as an addendum to the NOTICE text from the Work,
provided that such additional attribution notices cannot be construed as
modifying the License.
You may add Your own copyright statement to Your modifications and may provide
additional or different license terms and conditions for use, reproduction, or
distribution of Your modifications, or for any such Derivative Works as a whole,
provided Your use, reproduction, and distribution of the Work otherwise complies
with the conditions stated in this License.
5. Submission of Contributions.
Unless You explicitly state otherwise, any Contribution intentionally submitted
for inclusion in the Work by You to the Licensor shall be under the terms and
conditions of this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify the terms of
any separate license agreement you may have executed with Licensor regarding
such Contributions.
6. Trademarks.
This License does not grant permission to use the trade names, trademarks,
service marks, or product names of the Licensor, except as required for
reasonable and customary use in describing the origin of the Work and
reproducing the content of the NOTICE file.
7. Disclaimer of Warranty.
Unless required by applicable law or agreed to in writing, Licensor provides the
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
including, without limitation, any warranties or conditions of TITLE,
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
solely responsible for determining the appropriateness of using or
redistributing the Work and assume any risks associated with Your exercise of
permissions under this License.
8. Limitation of Liability.
In no event and under no legal theory, whether in tort (including negligence),
contract, or otherwise, unless required by applicable law (such as deliberate
and grossly negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special, incidental,
or consequential damages of any character arising as a result of this License or
out of the use or inability to use the Work (including but not limited to
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
any and all other commercial damages or losses), even if such Contributor has
been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability.
While redistributing the Work or Derivative Works thereof, You may choose to
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
other liability obligations and/or rights consistent with this License. However,
in accepting such obligations, You may act only on Your own behalf and on Your
sole responsibility, not on behalf of any other Contributor, and only if You
agree to indemnify, defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason of your
accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work
To apply the Apache License to your work, attach the following boilerplate
notice, with the fields enclosed by brackets "[]" replaced with your own
identifying information. (Don't include the brackets!) The text should be
enclosed in the appropriate comment syntax for the file format. We also
recommend that a file or class name and description of purpose be included on
the same "printed page" as the copyright notice for easier identification within
third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
================================================
FILE: README.md
================================================
# sharp
<img src="https://sharp.pixelplumbing.com/sharp-logo.svg" width="160" height="160" alt="sharp logo" align="right">
The typical use case for this high speed Node-API module
is to convert large images in common formats to
smaller, web-friendly JPEG, PNG, WebP, GIF and AVIF images of varying dimensions.
It can be used with all JavaScript runtimes
that provide support for Node-API v9, including
Node.js (^18.17.0 or >= 20.3.0), Deno and Bun.
Resizing an image is typically 4x-5x faster than using the
quickest ImageMagick and GraphicsMagick settings
due to its use of [libvips](https://github.com/libvips/libvips).
Colour spaces, embedded ICC profiles and alpha transparency channels are all handled correctly.
Lanczos resampling ensures quality is not sacrificed for speed.
As well as image resizing, operations such as
rotation, extraction, compositing and gamma correction are available.
Most modern macOS, Windows and Linux systems
do not require any additional install or runtime dependencies.
## Documentation
Visit [sharp.pixelplumbing.com](https://sharp.pixelplumbing.com/) for complete
[installation instructions](https://sharp.pixelplumbing.com/install),
[API documentation](https://sharp.pixelplumbing.com/api-constructor),
[benchmark tests](https://sharp.pixelplumbing.com/performance) and
[changelog](https://sharp.pixelplumbing.com/changelog).
## Examples
```sh
npm install sharp
```
```javascript
const sharp = require('sharp');
```
### Callback
```javascript
sharp(inputBuffer)
.resize(320, 240)
.toFile('output.webp', (err, info) => { ... });
```
### Promise
```javascript
sharp('input.jpg')
.rotate()
.resize(200)
.jpeg({ mozjpeg: true })
.toBuffer()
.then( data => { ... })
.catch( err => { ... });
```
### Async/await
```javascript
const semiTransparentRedPng = await sharp({
create: {
width: 48,
height: 48,
channels: 4,
background: { r: 255, g: 0, b: 0, alpha: 0.5 }
}
})
.png()
.toBuffer();
```
### Stream
```javascript
const roundedCorners = Buffer.from(
'<svg><rect x="0" y="0" width="200" height="200" rx="50" ry="50"/></svg>'
);
const roundedCornerResizer =
sharp()
.resize(200, 200)
.composite([{
input: roundedCorners,
blend: 'dest-in'
}])
.png();
readableStream
.pipe(roundedCornerResizer)
.pipe(writableStream);
```
## Contributing
A [guide for contributors](https://github.com/lovell/sharp/blob/main/.github/CONTRIBUTING.md)
covers reporting bugs, requesting features and submitting code changes.
## Licensing
Copyright 2013 Lovell Fuller and others.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
[https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
================================================
FILE: biome.json
================================================
{
"$schema": "https://biomejs.dev/schemas/2.3.4/schema.json",
"vcs": {
"enabled": true,
"clientKind": "git",
"useIgnoreFile": true
},
"files": {
"ignoreUnknown": true
},
"linter": {
"enabled": true,
"rules": {
"recommended": true
}
},
"formatter": {
"enabled": false,
"useEditorconfig": true
},
"javascript": {
"formatter": {
"quoteStyle": "single"
}
}
}
================================================
FILE: docs/astro.config.mjs
================================================
// @ts-check
import starlight from '@astrojs/starlight';
import { defineConfig } from 'astro/config';
import starlightAutoSidebar from 'starlight-auto-sidebar';
import { version } from '../package.json';
export default defineConfig({
site: 'https://sharp.pixelplumbing.com',
integrations: [
starlight({
title: 'sharp',
description:
'High performance Node.js image processing. The fastest module to resize JPEG, PNG, WebP and TIFF images.',
logo: {
src: './src/assets/sharp-logo.svg',
alt: '#'
},
customCss: ['./src/styles/custom.css'],
head: [{
tag: 'meta',
attrs: {
'http-equiv': 'Content-Security-Policy',
content: "default-src 'self'; connect-src 'self'; object-src 'none'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; script-src 'self' 'unsafe-inline' 'unsafe-eval' https://static.cloudflareinsights.com/beacon.min.js/;"
}
}, {
tag: 'link',
attrs: {
rel: 'author',
href: '/humans.txt',
type: 'text/plain'
}
}, {
tag: 'script',
attrs: {
type: 'application/ld+json'
},
content: JSON.stringify({
'@context': 'https://schema.org',
'@type': 'SoftwareSourceCode',
name: 'sharp',
description: 'High performance Node.js image processing',
url: 'https://sharp.pixelplumbing.com',
codeRepository: 'https://github.com/lovell/sharp',
programmingLanguage: ['JavaScript', 'C++'],
runtimePlatform: 'Node.js',
copyrightHolder: {
'@context': 'https://schema.org',
'@type': 'Person',
name: 'Lovell Fuller'
},
copyrightYear: 2013,
license: 'https://www.apache.org/licenses/LICENSE-2.0'
})
}],
sidebar: [
{ label: 'Home', link: '/' },
{ label: 'Installation', slug: 'install' },
{
label: 'API',
items: [
{ label: 'Constructor', slug: 'api-constructor' },
{ label: 'Input metadata', slug: 'api-input' },
{ label: 'Output options', slug: 'api-output' },
{ label: 'Resizing images', slug: 'api-resize' },
{ label: 'Compositing images', slug: 'api-composite' },
{ label: 'Image operations', slug: 'api-operation' },
{ label: 'Colour manipulation', slug: 'api-colour' },
{ label: 'Channel manipulation', slug: 'api-channel' },
{ label: 'Global properties', slug: 'api-utility' }
]
},
{ label: 'Performance', slug: 'performance' },
{
label: 'Changelog',
collapsed: true,
autogenerate: { directory: 'changelog' }
}
],
social: [
{ icon: 'openCollective', label: 'Open Collective', href: 'https://opencollective.com/libvips' },
{ icon: 'github', label: 'GitHub', href: 'https://github.com/lovell/sharp' }
],
plugins: [starlightAutoSidebar()]
})
],
redirects: {
'/changelog': `/changelog/v${version}`
}
});
================================================
FILE: docs/build.mjs
================================================
/*!
Copyright 2013 Lovell Fuller and others.
SPDX-License-Identifier: Apache-2.0
*/
import fs from 'node:fs/promises';
import path from 'node:path';
import jsdoc2md from 'jsdoc-to-markdown';
const pages = {
constructor: 'Constructor',
input: 'Input metadata',
resize: 'Resizing images',
composite: 'Compositing images',
operation: 'Image operations',
colour: 'Colour manipulation',
channel: 'Channel manipulation',
output: 'Output options',
utility: 'Global properties'
};
Object.keys(pages).forEach(async (m) => {
const input = path.join('lib', `${m}.js`);
const output = path.join('docs', 'src', 'content', 'docs', `api-${m}.md`);
const ast = await jsdoc2md.getTemplateData({ files: input });
const markdown = await jsdoc2md.render({
data: ast,
'global-index-format': 'none',
'module-index-format': 'none'
});
const cleanMarkdown =
`---\n# This file was auto-generated from JSDoc in lib/${m}.js\ntitle: ${pages[m]}\n---\n\n` +
markdown
.replace(/(## )([A-Za-z0-9]+)([^\n]*)/g, '$1$2\n> $2$3\n') // simplify headings
.replace(/<a name="[A-Za-z0-9+]+"><\/a>/g, '') // remove anchors
.replace(/\*\*Kind\*\*: global[^\n]+/g, '') // remove all "global" Kind labels (requires JSDoc refactoring)
.trim();
await fs.writeFile(output, cleanMarkdown);
});
================================================
FILE: docs/firebase.json
================================================
{
"hosting": {
"site": "pixelplumbing-sharp",
"public": "dist",
"headers": [
{
"source": "**",
"headers": [
{ "key": "Cache-Control", "value": "max-age=86400" },
{ "key": "X-Content-Type-Options", "value": "nosniff" },
{ "key": "X-Frame-Options", "value": "SAMEORIGIN" }
]
}
]
}
}
================================================
FILE: docs/package.json
================================================
{
"name": "sharp-docs",
"type": "module",
"version": "0.0.1",
"private": true,
"scripts": {
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"preview": "astro preview",
"astro": "astro"
},
"dependencies": {
"@astrojs/starlight": "^0.36.2",
"astro": "^5.15.3",
"starlight-auto-sidebar": "^0.1.3"
}
}
================================================
FILE: docs/public/humans.txt
================================================
/* THANKS */
Name: John Cupitt
GitHub: https://github.com/jcupitt
Name: Pierre Inglebert
GitHub: https://github.com/pierreinglebert
Name: Jonathan Ong
GitHub: https://github.com/jonathanong
Name: Chanon Sajjamanochai
GitHub: https://github.com/chanon
Name: Juliano Julio
GitHub: https://github.com/julianojulio
Name: Daniel Gasienica
GitHub: https://github.com/gasi
Name: Julian Walker
GitHub: https://github.com/julianwa
Name: Amit Pitaru
GitHub: https://github.com/apitaru
Name: Brandon Aaron
GitHub: https://github.com/brandonaaron
Name: Andreas Lind
GitHub: https://github.com/papandreou
Name: Maurus Cuelenaere
GitHub: https://github.com/mcuelenaere
Name: Linus Unnebäck
GitHub: https://github.com/LinusU
Name: Victor Mateevitsi
GitHub: https://github.com/mvictoras
Name: Alaric Holloway
GitHub: https://github.com/skedastik
Name: Bernhard K. Weisshuhn
GitHub: https://github.com/bkw
Name: David A. Carley
GitHub: https://github.com/dacarley
Name: John Tobin
GitHub: https://github.com/jtobinisaniceguy
Name: Kenton Gray
GitHub: https://github.com/kentongray
Name: Felix Bünemann
GitHub: https://github.com/felixbuenemann
Name: Samy Al Zahrani
GitHub: https://github.com/salzhrani
Name: Chintan Thakkar
GitHub: https://github.com/lemnisk8
Name: F. Orlando Galashan
GitHub: https://github.com/frulo
Name: Kleis Auke Wolthuizen
GitHub: https://github.com/kleisauke
Name: Matt Hirsch
GitHub: https://github.com/mhirsch
Name: Rahul Nanwani
GitHub: https://github.com/rnanwani
Name: Matthias Thoemmes
GitHub: https://github.com/cmtt
Name: Patrick Paskaris
GitHub: https://github.com/ppaskaris
Name: Jérémy Lal
GitHub: https://github.com/kapouer
Name: Alice Monday
GitHub: https://github.com/alice0meta
Name: Kristo Jorgenson
GitHub: https://github.com/kristojorg
Name: Yves Bos
GitHub: https://github.com/YvesBos
Name: Nicolas Coden
GitHub: https://github.com/ncoden
Name: Matt Parrish
GitHub: https://github.com/pbomb
Name: Matthew McEachen
GitHub: https://github.com/mceachen
Name: Jarda Kotěšovec
GitHub: https://github.com/jardakotesovec
Name: Kenric D'Souza
GitHub: https://github.com/AzureByte
Name: Oleh Aleinyk
GitHub: https://github.com/oaleynik
Name: Marcel Bretschneider
GitHub: https://github.com/3epnm
Name: Andrea Bianco
GitHub: https://github.com/BiancoA
Name: Rik Heywood
GitHub: https://github.com/rikh42
Name: Thomas Parisot
GitHub: https://github.com/oncletom
Name: Nathan Graves
GitHub: https://github.com/woolite64
Name: Tom Lokhorst
GitHub: https://github.com/tomlokhorst
Name: Espen Hovlandsdal
GitHub: https://github.com/rexxars
Name: Sylvain Dumont
GitHub: https://github.com/sylvaindumont
Name: Alun Davies
GitHub: https://github.com/alundavies
Name: Aidan Hoolachan
GitHub: https://github.com/ajhool
Name: Axel Eirola
GitHub: https://github.com/aeirola
Name: Freezy
GitHub: https://github.com/freezy
Name: Julian Aubourg
GitHub: https://github.com/jaubourg
Name: Keith Belovay
GitHub: https://github.com/fromkeith
Name: Michael B. Klein
GitHub: https://github.com/mbklein
Name: Jakub Michálek
GitHub: https://github.com/Goues
Name: Ilya Ovdin
GitHub: https://github.com/iovdin
Name: Andargor
GitHub: https://github.com/Andargor
Name: Nicolas Stepien
GitHub: https://github.com/MayhemYDG
Name: Paul Neave
GitHub: https://github.com/neave
Name: Brendan Kennedy
GitHub: https://github.com/rustyguts
Name: Brychan Bennett-Odlum
GitHub: https://github.com/BrychanOdlum
Name: Edward Silverton
GitHub: https://github.com/edsilv
Name: Dumitru Deveatii
GitHub: https://github.com/dimadeveatii
Name: Roland Asmann
GitHub: https://github.com/malice00
Name: Roman Malieiev
GitHub: https://github.com/romaleev
Name: Jerome Vouillon
GitHub: https://github.com/vouillon
Name: Tomáš Szabo
GitHub: https://github.com/deftomat
Name: Robert O'Rourke
GitHub: https://github.com/roborourke
Name: Denis Soldatov
GitHub: https://github.com/derom
Name: Stefan Probst
GitHub: https://github.com/stefanprobst
Name: Thomas Beiganz
GitHub: https://github.com/beig
Name: Florian Busch
GitHub: https://github.com/florian-busch
Name: Matthieu Salettes
GitHub: https://github.com/msalettes
Name: Taneli Vatanen
GitHub: https://github.com/Daiz
Name: Mart Jansink
GitHub: https://github.com/mart-jansink
Name: Tenpi
GitHub: https://github.com/Tenpi
Name: Zaruike
GitHub: https://github.com/Zaruike
Name: Erlend F
GitHub: https://github.com/erf
Name: Drian Naude
GitHub: https://github.com/driannaude
Name: Max Gordon
GitHub: https://github.com/gforge
Name: Chris Banks
GitHub: https://github.com/christopherbradleybanks
Name: codepage949
GitHub: https://github.com/codepage949
Name: Chris Hranj
GitHub: https://github.com/Brodan
Name: Ankur Parihar
GitHub: https://github.com/ankurparihar
Name: Joona Heinikoski
GitHub: https://github.com/joonamo
Name: AlexanderTheGrey
GitHub: https://github.com/AlexanderTheGrey
Name: Blayne Chard
GitHub: https://github.com/blacha
Name: Brahim
GitHub: https://github.com/brahima
Name: Anton Marsden
GitHub: https://github.com/antonmarsden
Name: Marcos Casagrande
GitHub: https://github.com/marcosc90
Name: Emanuel Jöbstl
GitHub: https://github.com/ejoebstl
Name: Tomasz Janowski
GitHub: https://github.com/janaz
Name: Lachlan Newman
GitHub: https://github.com/LachlanNewman
Name: BJJ
GitHub: https://github.com/bianjunjie1981
Name: Dennis Beatty
GitHub: https://github.com/dnsbty
Name: Ingvar Stepanyan
GitHub: https://github.com/RReverser
Name: Tamás András Horváth
GitHub: https://github.com/icetee
Name: Aaron Che
GitHub: https://github.com/yolopunk
Name: Mert Alev
GitHub: https://github.com/mertalev
Name: Adriaan Meuris
GitHub: https://github.com/adriaanmeuris
Name: Richard Hillmann
GitHub: https://github.com/project0
Name: Pongsatorn Manusopit
GitHub: https://github.com/ton11797
Name: Nathan Keynes
GitHub: https://github.com/nkeynes
Name: Sumit D
GitHub: https://github.com/sumitd2
Name: Caleb Meredith
GitHub: https://github.com/calebmer
Name: Don Denton
GitHub: https://github.com/happycollision
Name: Florent Zabera
GitHub: https://github.com/florentzabera
Name: Quentin Pinçon
GitHub: https://github.com/qpincon
Name: Hans Chen
GitHub: https://github.com/hans00
Name: Thibaut Patel
GitHub: https://github.com/tpatel
Name: Maël Nison
GitHub: https://github.com/arcanis
================================================
FILE: docs/public/robots.txt
================================================
User-agent: *
Disallow:
Sitemap: https://sharp.pixelplumbing.com/sitemap-index.xml
================================================
FILE: docs/src/content/docs/api-channel.md
================================================
---
# This file was auto-generated from JSDoc in lib/channel.js
title: Channel manipulation
---
## removeAlpha
> removeAlpha() ⇒ <code>Sharp</code>
Remove alpha channels, if any. This is a no-op if the image does not have an alpha channel.
See also [flatten](/api-operation/#flatten).
**Example**
```js
sharp('rgba.png')
.removeAlpha()
.toFile('rgb.png', function(err, info) {
// rgb.png is a 3 channel image without an alpha channel
});
```
## ensureAlpha
> ensureAlpha([alpha]) ⇒ <code>Sharp</code>
Ensure the output image has an alpha transparency channel.
If missing, the added alpha channel will have the specified
transparency level, defaulting to fully-opaque (1).
This is a no-op if the image already has an alpha channel.
**Throws**:
- <code>Error</code> Invalid alpha transparency level
**Since**: 0.21.2
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [alpha] | <code>number</code> | <code>1</code> | alpha transparency level (0=fully-transparent, 1=fully-opaque) |
**Example**
```js
// rgba.png will be a 4 channel image with a fully-opaque alpha channel
await sharp('rgb.jpg')
.ensureAlpha()
.toFile('rgba.png')
```
**Example**
```js
// rgba is a 4 channel image with a fully-transparent alpha channel
const rgba = await sharp(rgb)
.ensureAlpha(0)
.toBuffer();
```
## extractChannel
> extractChannel(channel) ⇒ <code>Sharp</code>
Extract a single channel from a multi-channel image.
The output colourspace will be either `b-w` (8-bit) or `grey16` (16-bit).
**Throws**:
- <code>Error</code> Invalid channel
| Param | Type | Description |
| --- | --- | --- |
| channel | <code>number</code> \| <code>string</code> | zero-indexed channel/band number to extract, or `red`, `green`, `blue` or `alpha`. |
**Example**
```js
// green.jpg is a greyscale image containing the green channel of the input
await sharp(input)
.extractChannel('green')
.toFile('green.jpg');
```
**Example**
```js
// red1 is the red value of the first pixel, red2 the second pixel etc.
const [red1, red2, ...] = await sharp(input)
.extractChannel(0)
.raw()
.toBuffer();
```
## joinChannel
> joinChannel(images, options) ⇒ <code>Sharp</code>
Join one or more channels to the image.
The meaning of the added channels depends on the output colourspace, set with `toColourspace()`.
By default the output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.
Channel ordering follows vips convention:
- sRGB: 0: Red, 1: Green, 2: Blue, 3: Alpha.
- CMYK: 0: Magenta, 1: Cyan, 2: Yellow, 3: Black, 4: Alpha.
Buffers may be any of the image formats supported by sharp.
For raw pixel input, the `options` object should contain a `raw` attribute, which follows the format of the attribute of the same name in the `sharp()` constructor.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Description |
| --- | --- | --- |
| images | <code>Array.<(string\|Buffer)></code> \| <code>string</code> \| <code>Buffer</code> | one or more images (file paths, Buffers). |
| options | <code>Object</code> | image options, see `sharp()` constructor. |
## bandbool
> bandbool(boolOp) ⇒ <code>Sharp</code>
Perform a bitwise boolean operation on all input image channels (bands) to produce a single channel output image.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Description |
| --- | --- | --- |
| boolOp | <code>string</code> | one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively. |
**Example**
```js
sharp('3-channel-rgb-input.png')
.bandbool(sharp.bool.and)
.toFile('1-channel-output.png', function (err, info) {
// The output will be a single channel image where each pixel `P = R & G & B`.
// If `I(1,1) = [247, 170, 14] = [0b11110111, 0b10101010, 0b00001111]`
// then `O(1,1) = 0b11110111 & 0b10101010 & 0b00001111 = 0b00000010 = 2`.
});
```
================================================
FILE: docs/src/content/docs/api-colour.md
================================================
---
# This file was auto-generated from JSDoc in lib/colour.js
title: Colour manipulation
---
## tint
> tint(tint) ⇒ <code>Sharp</code>
Tint the image using the provided colour.
An alpha channel may be present and will be unchanged by the operation.
**Throws**:
- <code>Error</code> Invalid parameter
| Param | Type | Description |
| --- | --- | --- |
| tint | <code>string</code> \| <code>Object</code> | Parsed by the [color](https://www.npmjs.org/package/color) module. |
**Example**
```js
const output = await sharp(input)
.tint({ r: 255, g: 240, b: 16 })
.toBuffer();
```
## greyscale
> greyscale([greyscale]) ⇒ <code>Sharp</code>
Convert to 8-bit greyscale; 256 shades of grey.
This is a linear operation. If the input image is in a non-linear colour space such as sRGB, use `gamma()` with `greyscale()` for the best results.
By default the output image will be web-friendly sRGB and contain three (identical) colour channels.
This may be overridden by other sharp operations such as `toColourspace('b-w')`,
which will produce an output image containing one colour channel.
An alpha channel may be present, and will be unchanged by the operation.
| Param | Type | Default |
| --- | --- | --- |
| [greyscale] | <code>Boolean</code> | <code>true</code> |
**Example**
```js
const output = await sharp(input).greyscale().toBuffer();
```
## grayscale
> grayscale([grayscale]) ⇒ <code>Sharp</code>
Alternative spelling of `greyscale`.
| Param | Type | Default |
| --- | --- | --- |
| [grayscale] | <code>Boolean</code> | <code>true</code> |
## pipelineColourspace
> pipelineColourspace([colourspace]) ⇒ <code>Sharp</code>
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).
**Throws**:
- <code>Error</code> Invalid parameters
**Since**: 0.29.0
| Param | Type | Description |
| --- | --- | --- |
| [colourspace] | <code>string</code> | pipeline colourspace e.g. `rgb16`, `scrgb`, `lab`, `grey16` [...](https://www.libvips.org/API/current/enum.Interpretation.html) |
**Example**
```js
// Run pipeline in 16 bits per channel RGB while converting final result to 8 bits per channel sRGB.
await sharp(input)
.pipelineColourspace('rgb16')
.toColourspace('srgb')
.toFile('16bpc-pipeline-to-8bpc-output.png')
```
## pipelineColorspace
> pipelineColorspace([colorspace]) ⇒ <code>Sharp</code>
Alternative spelling of `pipelineColourspace`.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Description |
| --- | --- | --- |
| [colorspace] | <code>string</code> | pipeline colorspace. |
## toColourspace
> toColourspace([colourspace]) ⇒ <code>Sharp</code>
Set the output colourspace.
By default output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Description |
| --- | --- | --- |
| [colourspace] | <code>string</code> | output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://www.libvips.org/API/current/enum.Interpretation.html) |
**Example**
```js
// Output 16 bits per pixel RGB
await sharp(input)
.toColourspace('rgb16')
.toFile('16-bpp.png')
```
## toColorspace
> toColorspace([colorspace]) ⇒ <code>Sharp</code>
Alternative spelling of `toColourspace`.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Description |
| --- | --- | --- |
| [colorspace] | <code>string</code> | output colorspace. |
================================================
FILE: docs/src/content/docs/api-composite.md
================================================
---
# This file was auto-generated from JSDoc in lib/composite.js
title: Compositing images
---
## composite
> composite(images) ⇒ <code>Sharp</code>
Composite image(s) over the processed (resized, extracted etc.) image.
The images to composite must be the same size or smaller than the processed image.
If both `top` and `left` options are provided, they take precedence over `gravity`.
Other operations in the same processing pipeline (e.g. resize, rotate, flip,
flop, extract) will always be applied to the input image before composition.
The `blend` option can be one of `clear`, `source`, `over`, `in`, `out`, `atop`,
`dest`, `dest-over`, `dest-in`, `dest-out`, `dest-atop`,
`xor`, `add`, `saturate`, `multiply`, `screen`, `overlay`, `darken`, `lighten`,
`colour-dodge`, `color-dodge`, `colour-burn`,`color-burn`,
`hard-light`, `soft-light`, `difference`, `exclusion`.
More information about blend modes can be found at
https://www.libvips.org/API/current/enum.BlendMode.html
and https://www.cairographics.org/operators/
**Throws**:
- <code>Error</code> Invalid parameters
**Since**: 0.22.0
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| images | <code>Array.<Object></code> | | Ordered list of images to composite |
| [images[].input] | <code>Buffer</code> \| <code>String</code> | | Buffer containing image data, String containing the path to an image file, or Create object (see below) |
| [images[].input.create] | <code>Object</code> | | describes a blank overlay to be created. |
| [images[].input.create.width] | <code>Number</code> | | |
| [images[].input.create.height] | <code>Number</code> | | |
| [images[].input.create.channels] | <code>Number</code> | | 3-4 |
| [images[].input.create.background] | <code>String</code> \| <code>Object</code> | | parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha. |
| [images[].input.text] | <code>Object</code> | | describes a new text image to be created. |
| [images[].input.text.text] | <code>string</code> | | text to render as a UTF-8 string. It can contain Pango markup, for example `<i>Le</i>Monde`. |
| [images[].input.text.font] | <code>string</code> | | font name to render with. |
| [images[].input.text.fontfile] | <code>string</code> | | absolute filesystem path to a font file that can be used by `font`. |
| [images[].input.text.width] | <code>number</code> | <code>0</code> | integral number of pixels to word-wrap at. Lines of text wider than this will be broken at word boundaries. |
| [images[].input.text.height] | <code>number</code> | <code>0</code> | integral number of pixels high. When defined, `dpi` will be ignored and the text will automatically fit the pixel resolution defined by `width` and `height`. Will be ignored if `width` is not specified or set to 0. |
| [images[].input.text.align] | <code>string</code> | <code>"'left'"</code> | text alignment (`'left'`, `'centre'`, `'center'`, `'right'`). |
| [images[].input.text.justify] | <code>boolean</code> | <code>false</code> | set this to true to apply justification to the text. |
| [images[].input.text.dpi] | <code>number</code> | <code>72</code> | the resolution (size) at which to render the text. Does not take effect if `height` is specified. |
| [images[].input.text.rgba] | <code>boolean</code> | <code>false</code> | set this to true to enable RGBA output. This is useful for colour emoji rendering, or support for Pango markup features like `<span foreground="red">Red!</span>`. |
| [images[].input.text.spacing] | <code>number</code> | <code>0</code> | text line height in points. Will use the font line height if none is specified. |
| [images[].autoOrient] | <code>Boolean</code> | <code>false</code> | set to true to use EXIF orientation data, if present, to orient the image. |
| [images[].blend] | <code>String</code> | <code>'over'</code> | how to blend this image with the image below. |
| [images[].gravity] | <code>String</code> | <code>'centre'</code> | gravity at which to place the overlay. |
| [images[].top] | <code>Number</code> | | the pixel offset from the top edge. |
| [images[].left] | <code>Number</code> | | the pixel offset from the left edge. |
| [images[].tile] | <code>Boolean</code> | <code>false</code> | set to true to repeat the overlay image across the entire image with the given `gravity`. |
| [images[].premultiplied] | <code>Boolean</code> | <code>false</code> | set to true to avoid premultiplying the image below. Equivalent to the `--premultiplied` vips option. |
| [images[].density] | <code>Number</code> | <code>72</code> | number representing the DPI for vector overlay image. |
| [images[].raw] | <code>Object</code> | | describes overlay when using raw pixel data. |
| [images[].raw.width] | <code>Number</code> | | |
| [images[].raw.height] | <code>Number</code> | | |
| [images[].raw.channels] | <code>Number</code> | | |
| [images[].animated] | <code>boolean</code> | <code>false</code> | Set to `true` to read all frames/pages of an animated image. |
| [images[].failOn] | <code>string</code> | <code>"'warning'"</code> | @see [constructor parameters](/api-constructor/) |
| [images[].limitInputPixels] | <code>number</code> \| <code>boolean</code> | <code>268402689</code> | @see [constructor parameters](/api-constructor/) |
**Example**
```js
await sharp(background)
.composite([
{ input: layer1, gravity: 'northwest' },
{ input: layer2, gravity: 'southeast' },
])
.toFile('combined.png');
```
**Example**
```js
const output = await sharp('input.gif', { animated: true })
.composite([
{ input: 'overlay.png', tile: true, blend: 'saturate' }
])
.toBuffer();
```
**Example**
```js
sharp('input.png')
.rotate(180)
.resize(300)
.flatten( { background: '#ff6600' } )
.composite([{ input: 'overlay.png', gravity: 'southeast' }])
.sharpen()
.withMetadata()
.webp( { quality: 90 } )
.toBuffer()
.then(function(outputBuffer) {
// outputBuffer contains upside down, 300px wide, alpha channel flattened
// onto orange background, composited with overlay.png with SE gravity,
// sharpened, with metadata, 90% quality WebP image data. Phew!
});
```
================================================
FILE: docs/src/content/docs/api-constructor.md
================================================
---
# This file was auto-generated from JSDoc in lib/constructor.js
title: Constructor
---
## Sharp
> Sharp
**Emits**: <code>Sharp#event:info</code>, <code>Sharp#event:warning</code>
<a name="new_Sharp_new"></a>
### new
> new Sharp([input], [options])
Constructor factory to create an instance of `sharp`, to which further methods are chained.
JPEG, PNG, WebP, GIF, AVIF or TIFF format image data can be streamed out from this object.
When using Stream based output, derived attributes are available from the `info` event.
Non-critical problems encountered during processing are emitted as `warning` events.
Implements the [stream.Duplex](http://nodejs.org/api/stream.html#stream_class_stream_duplex) class.
When loading more than one page/frame of an animated image,
these are combined as a vertically-stacked "toilet roll" image
where the overall height is the `pageHeight` multiplied by the number of `pages`.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [input] | <code>Buffer</code> \| <code>ArrayBuffer</code> \| <code>Uint8Array</code> \| <code>Uint8ClampedArray</code> \| <code>Int8Array</code> \| <code>Uint16Array</code> \| <code>Int16Array</code> \| <code>Uint32Array</code> \| <code>Int32Array</code> \| <code>Float32Array</code> \| <code>Float64Array</code> \| <code>string</code> \| <code>Array</code> | | if present, can be a Buffer / ArrayBuffer / Uint8Array / Uint8ClampedArray containing JPEG, PNG, WebP, AVIF, GIF, SVG or TIFF image data, or a TypedArray containing raw pixel image data, or a String containing the filesystem path to an JPEG, PNG, WebP, AVIF, GIF, SVG or TIFF image file. An array of inputs can be provided, and these will be joined together. JPEG, PNG, WebP, AVIF, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when not present. |
| [options] | <code>Object</code> | | if present, is an Object with optional attributes. |
| [options.failOn] | <code>string</code> | <code>"'warning'"</code> | When to abort processing of invalid pixel data, one of (in order of sensitivity, least to most): 'none', 'truncated', 'error', 'warning'. Higher levels imply lower levels. Invalid metadata will always abort. |
| [options.limitInputPixels] | <code>number</code> \| <code>boolean</code> | <code>268402689</code> | Do not process input images where the number of pixels (width x height) exceeds this limit. Assumes image dimensions contained in the input metadata can be trusted. An integral Number of pixels, zero or false to remove limit, true to use default limit of 268402689 (0x3FFF x 0x3FFF). |
| [options.unlimited] | <code>boolean</code> | <code>false</code> | Set this to `true` to remove safety features that help prevent memory exhaustion (JPEG, PNG, SVG, HEIF). |
| [options.autoOrient] | <code>boolean</code> | <code>false</code> | Set this to `true` to rotate/flip the image to match EXIF `Orientation`, if any. |
| [options.sequentialRead] | <code>boolean</code> | <code>true</code> | Set this to `false` to use random access rather than sequential read. Some operations will do this automatically. |
| [options.density] | <code>number</code> | <code>72</code> | number representing the DPI for vector images in the range 1 to 100000. |
| [options.ignoreIcc] | <code>number</code> | <code>false</code> | should the embedded ICC profile, if any, be ignored. |
| [options.pages] | <code>number</code> | <code>1</code> | Number of pages to extract for multi-page input (GIF, WebP, TIFF), use -1 for all pages. |
| [options.page] | <code>number</code> | <code>0</code> | Page number to start extracting from for multi-page input (GIF, WebP, TIFF), zero based. |
| [options.animated] | <code>boolean</code> | <code>false</code> | Set to `true` to read all frames/pages of an animated image (GIF, WebP, TIFF), equivalent of setting `pages` to `-1`. |
| [options.raw] | <code>Object</code> | | describes raw pixel input image data. See `raw()` for pixel ordering. |
| [options.raw.width] | <code>number</code> | | integral number of pixels wide. |
| [options.raw.height] | <code>number</code> | | integral number of pixels high. |
| [options.raw.channels] | <code>number</code> | | integral number of channels, between 1 and 4. |
| [options.raw.premultiplied] | <code>boolean</code> | | specifies that the raw input has already been premultiplied, set to `true` to avoid sharp premultiplying the image. (optional, default `false`) |
| [options.raw.pageHeight] | <code>number</code> | | The pixel height of each page/frame for animated images, must be an integral factor of `raw.height`. |
| [options.create] | <code>Object</code> | | describes a new image to be created. |
| [options.create.width] | <code>number</code> | | integral number of pixels wide. |
| [options.create.height] | <code>number</code> | | integral number of pixels high. |
| [options.create.channels] | <code>number</code> | | integral number of channels, either 3 (RGB) or 4 (RGBA). |
| [options.create.background] | <code>string</code> \| <code>Object</code> | | parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha. |
| [options.create.pageHeight] | <code>number</code> | | The pixel height of each page/frame for animated images, must be an integral factor of `create.height`. |
| [options.create.noise] | <code>Object</code> | | describes a noise to be created. |
| [options.create.noise.type] | <code>string</code> | | type of generated noise, currently only `gaussian` is supported. |
| [options.create.noise.mean] | <code>number</code> | <code>128</code> | Mean value of pixels in the generated noise. |
| [options.create.noise.sigma] | <code>number</code> | <code>30</code> | Standard deviation of pixel values in the generated noise. |
| [options.text] | <code>Object</code> | | describes a new text image to be created. |
| [options.text.text] | <code>string</code> | | text to render as a UTF-8 string. It can contain Pango markup, for example `<i>Le</i>Monde`. |
| [options.text.font] | <code>string</code> | | font name to render with. |
| [options.text.fontfile] | <code>string</code> | | absolute filesystem path to a font file that can be used by `font`. |
| [options.text.width] | <code>number</code> | <code>0</code> | Integral number of pixels to word-wrap at. Lines of text wider than this will be broken at word boundaries. |
| [options.text.height] | <code>number</code> | <code>0</code> | Maximum integral number of pixels high. When defined, `dpi` will be ignored and the text will automatically fit the pixel resolution defined by `width` and `height`. Will be ignored if `width` is not specified or set to 0. |
| [options.text.align] | <code>string</code> | <code>"'left'"</code> | Alignment style for multi-line text (`'left'`, `'centre'`, `'center'`, `'right'`). |
| [options.text.justify] | <code>boolean</code> | <code>false</code> | set this to true to apply justification to the text. |
| [options.text.dpi] | <code>number</code> | <code>72</code> | the resolution (size) at which to render the text. Does not take effect if `height` is specified. |
| [options.text.rgba] | <code>boolean</code> | <code>false</code> | set this to true to enable RGBA output. This is useful for colour emoji rendering, or support for pango markup features like `<span foreground="red">Red!</span>`. |
| [options.text.spacing] | <code>number</code> | <code>0</code> | text line height in points. Will use the font line height if none is specified. |
| [options.text.wrap] | <code>string</code> | <code>"'word'"</code> | word wrapping style when width is provided, one of: 'word', 'char', 'word-char' (prefer word, fallback to char) or 'none'. |
| [options.join] | <code>Object</code> | | describes how an array of input images should be joined. |
| [options.join.across] | <code>number</code> | <code>1</code> | number of images to join horizontally. |
| [options.join.animated] | <code>boolean</code> | <code>false</code> | set this to `true` to join the images as an animated image. |
| [options.join.shim] | <code>number</code> | <code>0</code> | number of pixels to insert between joined images. |
| [options.join.background] | <code>string</code> \| <code>Object</code> | | parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha. |
| [options.join.halign] | <code>string</code> | <code>"'left'"</code> | horizontal alignment style for images joined horizontally (`'left'`, `'centre'`, `'center'`, `'right'`). |
| [options.join.valign] | <code>string</code> | <code>"'top'"</code> | vertical alignment style for images joined vertically (`'top'`, `'centre'`, `'center'`, `'bottom'`). |
| [options.tiff] | <code>Object</code> | | Describes TIFF specific options. |
| [options.tiff.subifd] | <code>number</code> | <code>-1</code> | Sub Image File Directory to extract for OME-TIFF, defaults to main image. |
| [options.svg] | <code>Object</code> | | Describes SVG specific options. |
| [options.svg.stylesheet] | <code>string</code> | | Custom CSS for SVG input, applied with a User Origin during the CSS cascade. |
| [options.svg.highBitdepth] | <code>boolean</code> | <code>false</code> | Set to `true` to render SVG input at 32-bits per channel (128-bit) instead of 8-bits per channel (32-bit) RGBA. |
| [options.pdf] | <code>Object</code> | | Describes PDF specific options. Requires the use of a globally-installed libvips compiled with support for PDFium, Poppler, ImageMagick or GraphicsMagick. |
| [options.pdf.background] | <code>string</code> \| <code>Object</code> | | Background colour to use when PDF is partially transparent. Parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha. |
| [options.openSlide] | <code>Object</code> | | Describes OpenSlide specific options. Requires the use of a globally-installed libvips compiled with support for OpenSlide. |
| [options.openSlide.level] | <code>number</code> | <code>0</code> | Level to extract from a multi-level input, zero based. |
| [options.jp2] | <code>Object</code> | | Describes JPEG 2000 specific options. Requires the use of a globally-installed libvips compiled with support for OpenJPEG. |
| [options.jp2.oneshot] | <code>boolean</code> | <code>false</code> | Set to `true` to decode tiled JPEG 2000 images in a single operation, improving compatibility. |
**Example**
```js
sharp('input.jpg')
.resize(300, 200)
.toFile('output.jpg', function(err) {
// output.jpg is a 300 pixels wide and 200 pixels high image
// containing a scaled and cropped version of input.jpg
});
```
**Example**
```js
// Read image data from remote URL,
// resize to 300 pixels wide,
// emit an 'info' event with calculated dimensions
// and finally write image data to writableStream
const { body } = fetch('https://...');
const readableStream = Readable.fromWeb(body);
const transformer = sharp()
.resize(300)
.on('info', ({ height }) => {
console.log(`Image height is ${height}`);
});
readableStream.pipe(transformer).pipe(writableStream);
```
**Example**
```js
// Create a blank 300x200 PNG image of semi-translucent red pixels
sharp({
create: {
width: 300,
height: 200,
channels: 4,
background: { r: 255, g: 0, b: 0, alpha: 0.5 }
}
})
.png()
.toBuffer()
.then( ... );
```
**Example**
```js
// Convert an animated GIF to an animated WebP
await sharp('in.gif', { animated: true }).toFile('out.webp');
```
**Example**
```js
// Read a raw array of pixels and save it to a png
const input = Uint8Array.from([255, 255, 255, 0, 0, 0]); // or Uint8ClampedArray
const image = sharp(input, {
// because the input does not contain its dimensions or how many channels it has
// we need to specify it in the constructor options
raw: {
width: 2,
height: 1,
channels: 3
}
});
await image.toFile('my-two-pixels.png');
```
**Example**
```js
// Generate RGB Gaussian noise
await sharp({
create: {
width: 300,
height: 200,
channels: 3,
noise: {
type: 'gaussian',
mean: 128,
sigma: 30
}
}
}).toFile('noise.png');
```
**Example**
```js
// Generate an image from text
await sharp({
text: {
text: 'Hello, world!',
width: 400, // max width
height: 300 // max height
}
}).toFile('text_bw.png');
```
**Example**
```js
// Generate an rgba image from text using pango markup and font
await sharp({
text: {
text: '<span foreground="red">Red!</span><span background="cyan">blue</span>',
font: 'sans',
rgba: true,
dpi: 300
}
}).toFile('text_rgba.png');
```
**Example**
```js
// Join four input images as a 2x2 grid with a 4 pixel gutter
const data = await sharp(
[image1, image2, image3, image4],
{ join: { across: 2, shim: 4 } }
).toBuffer();
```
**Example**
```js
// Generate a two-frame animated image from emoji
const images = ['😀', '😛'].map(text => ({
text: { text, width: 64, height: 64, channels: 4, rgba: true }
}));
await sharp(images, { join: { animated: true } }).toFile('out.gif');
```
## clone
> clone() ⇒ [<code>Sharp</code>](#Sharp)
Take a "snapshot" of the Sharp instance, returning a new instance.
Cloned instances inherit the input of their parent instance.
This allows multiple output Streams and therefore multiple processing pipelines to share a single input Stream.
**Example**
```js
const pipeline = sharp().rotate();
pipeline.clone().resize(800, 600).pipe(firstWritableStream);
pipeline.clone().extract({ left: 20, top: 20, width: 100, height: 100 }).pipe(secondWritableStream);
readableStream.pipe(pipeline);
// firstWritableStream receives auto-rotated, resized readableStream
// secondWritableStream receives auto-rotated, extracted region of readableStream
```
**Example**
```js
// Create a pipeline that will download an image, resize it and format it to different files
// Using Promises to know when the pipeline is complete
const fs = require("fs");
const got = require("got");
const sharpStream = sharp({ failOn: 'none' });
const promises = [];
promises.push(
sharpStream
.clone()
.jpeg({ quality: 100 })
.toFile("originalFile.jpg")
);
promises.push(
sharpStream
.clone()
.resize({ width: 500 })
.jpeg({ quality: 80 })
.toFile("optimized-500.jpg")
);
promises.push(
sharpStream
.clone()
.resize({ width: 500 })
.webp({ quality: 80 })
.toFile("optimized-500.webp")
);
// https://github.com/sindresorhus/got/blob/main/documentation/3-streams.md
got.stream("https://www.example.com/some-file.jpg").pipe(sharpStream);
Promise.all(promises)
.then(res => { console.log("Done!", res); })
.catch(err => {
console.error("Error processing files, let's clean it up", err);
try {
fs.unlinkSync("originalFile.jpg");
fs.unlinkSync("optimized-500.jpg");
fs.unlinkSync("optimized-500.webp");
} catch (e) {}
});
```
================================================
FILE: docs/src/content/docs/api-input.md
================================================
---
# This file was auto-generated from JSDoc in lib/input.js
title: Input metadata
---
## metadata
> metadata([callback]) ⇒ <code>Promise.<Object></code> \| <code>Sharp</code>
Fast access to (uncached) image metadata without decoding any compressed pixel data.
This is read from the header of the input image.
It does not take into consideration any operations to be applied to the output image,
such as resize or rotate.
Dimensions in the response will respect the `page` and `pages` properties of the
[constructor parameters](/api-constructor/).
A `Promise` is returned when `callback` is not provided.
- `format`: Name of decoder used to parse image e.g. `jpeg`, `png`, `webp`, `gif`, `svg`, `heif`, `tiff`
- `size`: Total size of image in bytes, for Stream and Buffer input only
- `width`: Number of pixels wide (EXIF orientation is not taken into consideration, see example below)
- `height`: Number of pixels high (EXIF orientation is not taken into consideration, see example below)
- `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://www.libvips.org/API/current/enum.Interpretation.html)
- `channels`: Number of bands e.g. `3` for sRGB, `4` for CMYK
- `depth`: Name of pixel depth format e.g. `uchar`, `char`, `ushort`, `float` [...](https://www.libvips.org/API/current/enum.BandFormat.html)
- `density`: Number of pixels per inch (DPI), if present
- `chromaSubsampling`: String containing JPEG chroma subsampling, `4:2:0` or `4:4:4` for RGB, `4:2:0:4` or `4:4:4:4` for CMYK
- `isProgressive`: Boolean indicating whether the image is interlaced using a progressive scan
- `isPalette`: Boolean indicating whether the image is palette-based (GIF, PNG).
- `bitsPerSample`: Number of bits per sample for each channel (GIF, PNG, HEIF).
- `pages`: Number of pages/frames contained within the image, with support for TIFF, HEIF, PDF, animated GIF and animated WebP
- `pageHeight`: Number of pixels high each page in a multi-page image will be.
- `loop`: Number of times to loop an animated image, zero refers to a continuous loop.
- `delay`: Delay in ms between each page in an animated image, provided as an array of integers.
- `pagePrimary`: Number of the primary page in a HEIF image
- `levels`: Details of each level in a multi-level image provided as an array of objects, requires libvips compiled with support for OpenSlide
- `subifds`: Number of Sub Image File Directories in an OME-TIFF image
- `background`: Default background colour, if present, for PNG (bKGD) and GIF images
- `compression`: The encoder used to compress an HEIF file, `av1` (AVIF) or `hevc` (HEIC)
- `resolutionUnit`: The unit of resolution (density), either `inch` or `cm`, if present
- `hasProfile`: Boolean indicating the presence of an embedded ICC profile
- `hasAlpha`: Boolean indicating the presence of an alpha transparency channel
- `orientation`: Number value of the EXIF Orientation header, if present
- `exif`: Buffer containing raw EXIF data, if present
- `icc`: Buffer containing raw [ICC](https://www.npmjs.com/package/icc) profile data, if present
- `iptc`: Buffer containing raw IPTC data, if present
- `xmp`: Buffer containing raw XMP data, if present
- `xmpAsString`: String containing XMP data, if valid UTF-8.
- `tifftagPhotoshop`: Buffer containing raw TIFFTAG_PHOTOSHOP data, if present
- `formatMagick`: String containing format for images loaded via *magick
- `comments`: Array of keyword/text pairs representing PNG text blocks, if present.
| Param | Type | Description |
| --- | --- | --- |
| [callback] | <code>function</code> | called with the arguments `(err, metadata)` |
**Example**
```js
const metadata = await sharp(input).metadata();
```
**Example**
```js
const image = sharp(inputJpg);
image
.metadata()
.then(function(metadata) {
return image
.resize(Math.round(metadata.width / 2))
.webp()
.toBuffer();
})
.then(function(data) {
// data contains a WebP image half the width and height of the original JPEG
});
```
**Example**
```js
// Get dimensions taking EXIF Orientation into account.
const { autoOrient } = await sharp(input).metadata();
const { width, height } = autoOrient;
```
## stats
> stats([callback]) ⇒ <code>Promise.<Object></code>
Access to pixel-derived image statistics for every channel in the image.
A `Promise` is returned when `callback` is not provided.
- `channels`: Array of channel statistics for each channel in the image. Each channel statistic contains
- `min` (minimum value in the channel)
- `max` (maximum value in the channel)
- `sum` (sum of all values in a channel)
- `squaresSum` (sum of squared values in a channel)
- `mean` (mean of the values in a channel)
- `stdev` (standard deviation for the values in a channel)
- `minX` (x-coordinate of one of the pixel where the minimum lies)
- `minY` (y-coordinate of one of the pixel where the minimum lies)
- `maxX` (x-coordinate of one of the pixel where the maximum lies)
- `maxY` (y-coordinate of one of the pixel where the maximum lies)
- `isOpaque`: Is the image fully opaque? Will be `true` if the image has no alpha channel or if every pixel is fully opaque.
- `entropy`: Histogram-based estimation of greyscale entropy, discarding alpha channel if any.
- `sharpness`: Estimation of greyscale sharpness based on the standard deviation of a Laplacian convolution, discarding alpha channel if any.
- `dominant`: Object containing most dominant sRGB colour based on a 4096-bin 3D histogram.
**Note**: Statistics are derived from the original input image. Any operations performed on the image must first be
written to a buffer in order to run `stats` on the result (see third example).
| Param | Type | Description |
| --- | --- | --- |
| [callback] | <code>function</code> | called with the arguments `(err, stats)` |
**Example**
```js
const image = sharp(inputJpg);
image
.stats()
.then(function(stats) {
// stats contains the channel-wise statistics array and the isOpaque value
});
```
**Example**
```js
const { entropy, sharpness, dominant } = await sharp(input).stats();
const { r, g, b } = dominant;
```
**Example**
```js
const image = sharp(input);
// store intermediate result
const part = await image.extract(region).toBuffer();
// create new instance to obtain statistics of extracted region
const stats = await sharp(part).stats();
```
================================================
FILE: docs/src/content/docs/api-operation.md
================================================
---
# This file was auto-generated from JSDoc in lib/operation.js
title: Image operations
---
## rotate
> rotate([angle], [options]) ⇒ <code>Sharp</code>
Rotate the output image.
The provided angle is converted to a valid positive degree rotation.
For example, `-450` will produce a 270 degree rotation.
When rotating by an angle other than a multiple of 90,
the background colour can be provided with the `background` option.
For backwards compatibility, if no angle is provided, `.autoOrient()` will be called.
Only one rotation can occur per pipeline (aside from an initial call without
arguments to orient via EXIF data). Previous calls to `rotate` in the same
pipeline will be ignored.
Multi-page images can only be rotated by 180 degrees.
Method order is important when rotating, resizing and/or extracting regions,
for example `.rotate(x).extract(y)` will produce a different result to `.extract(y).rotate(x)`.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [angle] | <code>number</code> | <code>auto</code> | angle of rotation. |
| [options] | <code>Object</code> | | if present, is an Object with optional attributes. |
| [options.background] | <code>string</code> \| <code>Object</code> | <code>"\"#000000\""</code> | parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha. |
**Example**
```js
const rotateThenResize = await sharp(input)
.rotate(90)
.resize({ width: 16, height: 8, fit: 'fill' })
.toBuffer();
const resizeThenRotate = await sharp(input)
.resize({ width: 16, height: 8, fit: 'fill' })
.rotate(90)
.toBuffer();
```
## autoOrient
> autoOrient() ⇒ <code>Sharp</code>
Auto-orient based on the EXIF `Orientation` tag, then remove the tag.
Mirroring is supported and may infer the use of a flip operation.
Previous or subsequent use of `rotate(angle)` and either `flip()` or `flop()`
will logically occur after auto-orientation, regardless of call order.
**Example**
```js
const output = await sharp(input).autoOrient().toBuffer();
```
**Example**
```js
const pipeline = sharp()
.autoOrient()
.resize(null, 200)
.toBuffer(function (err, outputBuffer, info) {
// outputBuffer contains 200px high JPEG image data,
// auto-oriented using EXIF Orientation tag
// info.width and info.height contain the dimensions of the resized image
});
readableStream.pipe(pipeline);
```
## flip
> flip([flip]) ⇒ <code>Sharp</code>
Mirror the image vertically (up-down) about the x-axis.
This always occurs before rotation, if any.
This operation does not work correctly with multi-page images.
| Param | Type | Default |
| --- | --- | --- |
| [flip] | <code>Boolean</code> | <code>true</code> |
**Example**
```js
const output = await sharp(input).flip().toBuffer();
```
## flop
> flop([flop]) ⇒ <code>Sharp</code>
Mirror the image horizontally (left-right) about the y-axis.
This always occurs before rotation, if any.
| Param | Type | Default |
| --- | --- | --- |
| [flop] | <code>Boolean</code> | <code>true</code> |
**Example**
```js
const output = await sharp(input).flop().toBuffer();
```
## affine
> affine(matrix, [options]) ⇒ <code>Sharp</code>
Perform an affine transform on an image. This operation will always occur after resizing, extraction and rotation, if any.
You must provide an array of length 4 or a 2x2 affine transformation matrix.
By default, new pixels are filled with a black background. You can provide a background colour with the `background` option.
A particular interpolator may also be specified. Set the `interpolator` option to an attribute of the `sharp.interpolators` Object e.g. `sharp.interpolators.nohalo`.
In the case of a 2x2 matrix, the transform is:
- X = `matrix[0, 0]` \* (x + `idx`) + `matrix[0, 1]` \* (y + `idy`) + `odx`
- Y = `matrix[1, 0]` \* (x + `idx`) + `matrix[1, 1]` \* (y + `idy`) + `ody`
where:
- x and y are the coordinates in input image.
- X and Y are the coordinates in output image.
- (0,0) is the upper left corner.
**Throws**:
- <code>Error</code> Invalid parameters
**Since**: 0.27.0
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| matrix | <code>Array.<Array.<number>></code> \| <code>Array.<number></code> | | affine transformation matrix |
| [options] | <code>Object</code> | | if present, is an Object with optional attributes. |
| [options.background] | <code>String</code> \| <code>Object</code> | <code>"#000000"</code> | parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha. |
| [options.idx] | <code>Number</code> | <code>0</code> | input horizontal offset |
| [options.idy] | <code>Number</code> | <code>0</code> | input vertical offset |
| [options.odx] | <code>Number</code> | <code>0</code> | output horizontal offset |
| [options.ody] | <code>Number</code> | <code>0</code> | output vertical offset |
| [options.interpolator] | <code>String</code> | <code>sharp.interpolators.bicubic</code> | interpolator |
**Example**
```js
const pipeline = sharp()
.affine([[1, 0.3], [0.1, 0.7]], {
background: 'white',
interpolator: sharp.interpolators.nohalo
})
.toBuffer((err, outputBuffer, info) => {
// outputBuffer contains the transformed image
// info.width and info.height contain the new dimensions
});
inputStream
.pipe(pipeline);
```
## sharpen
> sharpen([options], [flat], [jagged]) ⇒ <code>Sharp</code>
Sharpen the image.
When used without parameters, performs a fast, mild sharpen of the output image.
When a `sigma` is provided, performs a slower, more accurate sharpen of the L channel in the LAB colour space.
Fine-grained control over the level of sharpening in "flat" (m1) and "jagged" (m2) areas is available.
See [libvips sharpen](https://www.libvips.org/API/current/method.Image.sharpen.html) operation.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> \| <code>number</code> | | if present, is an Object with attributes |
| [options.sigma] | <code>number</code> | | the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`, between 0.000001 and 10 |
| [options.m1] | <code>number</code> | <code>1.0</code> | the level of sharpening to apply to "flat" areas, between 0 and 1000000 |
| [options.m2] | <code>number</code> | <code>2.0</code> | the level of sharpening to apply to "jagged" areas, between 0 and 1000000 |
| [options.x1] | <code>number</code> | <code>2.0</code> | threshold between "flat" and "jagged", between 0 and 1000000 |
| [options.y2] | <code>number</code> | <code>10.0</code> | maximum amount of brightening, between 0 and 1000000 |
| [options.y3] | <code>number</code> | <code>20.0</code> | maximum amount of darkening, between 0 and 1000000 |
| [flat] | <code>number</code> | | (deprecated) see `options.m1`. |
| [jagged] | <code>number</code> | | (deprecated) see `options.m2`. |
**Example**
```js
const data = await sharp(input).sharpen().toBuffer();
```
**Example**
```js
const data = await sharp(input).sharpen({ sigma: 2 }).toBuffer();
```
**Example**
```js
const data = await sharp(input)
.sharpen({
sigma: 2,
m1: 0,
m2: 3,
x1: 3,
y2: 15,
y3: 15,
})
.toBuffer();
```
## median
> median([size]) ⇒ <code>Sharp</code>
Apply median filter.
When used without parameters the default window is 3x3.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [size] | <code>number</code> | <code>3</code> | square mask size: size x size |
**Example**
```js
const output = await sharp(input).median().toBuffer();
```
**Example**
```js
const output = await sharp(input).median(5).toBuffer();
```
## blur
> blur([options]) ⇒ <code>Sharp</code>
Blur the image.
When used without parameters, performs a fast 3x3 box blur (equivalent to a box linear filter).
When a `sigma` is provided, performs a slower, more accurate Gaussian blur.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> \| <code>number</code> \| <code>Boolean</code> | | |
| [options.sigma] | <code>number</code> | | a value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`. |
| [options.precision] | <code>string</code> | <code>"'integer'"</code> | How accurate the operation should be, one of: integer, float, approximate. |
| [options.minAmplitude] | <code>number</code> | <code>0.2</code> | A value between 0.001 and 1. A smaller value will generate a larger, more accurate mask. |
**Example**
```js
const boxBlurred = await sharp(input)
.blur()
.toBuffer();
```
**Example**
```js
const gaussianBlurred = await sharp(input)
.blur(5)
.toBuffer();
```
## dilate
> dilate([width]) ⇒ <code>Sharp</code>
Expand foreground objects using the dilate morphological operator.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [width] | <code>Number</code> | <code>1</code> | dilation width in pixels. |
**Example**
```js
const output = await sharp(input)
.dilate()
.toBuffer();
```
## erode
> erode([width]) ⇒ <code>Sharp</code>
Shrink foreground objects using the erode morphological operator.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [width] | <code>Number</code> | <code>1</code> | erosion width in pixels. |
**Example**
```js
const output = await sharp(input)
.erode()
.toBuffer();
```
## flatten
> flatten([options]) ⇒ <code>Sharp</code>
Merge alpha transparency channel, if any, with a background, then remove the alpha channel.
See also [removeAlpha](/api-channel#removealpha).
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | |
| [options.background] | <code>string</code> \| <code>Object</code> | <code>"{r: 0, g: 0, b: 0}"</code> | background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to black. |
**Example**
```js
await sharp(rgbaInput)
.flatten({ background: '#F0A703' })
.toBuffer();
```
## unflatten
> unflatten()
Ensure the image has an alpha channel
with all white pixel values made fully transparent.
Existing alpha channel values for non-white pixels remain unchanged.
This feature is experimental and the API may change.
**Since**: 0.32.1
**Example**
```js
await sharp(rgbInput)
.unflatten()
.toBuffer();
```
**Example**
```js
await sharp(rgbInput)
.threshold(128, { grayscale: false }) // converter bright pixels to white
.unflatten()
.toBuffer();
```
## gamma
> gamma([gamma], [gammaOut]) ⇒ <code>Sharp</code>
Apply a gamma correction by reducing the encoding (darken) pre-resize at a factor of `1/gamma`
then increasing the encoding (brighten) post-resize at a factor of `gamma`.
This can improve the perceived brightness of a resized image in non-linear colour spaces.
JPEG and WebP input images will not take advantage of the shrink-on-load performance optimisation
when applying a gamma correction.
Supply a second argument to use a different output gamma value, otherwise the first value is used in both cases.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [gamma] | <code>number</code> | <code>2.2</code> | value between 1.0 and 3.0. |
| [gammaOut] | <code>number</code> | | value between 1.0 and 3.0. (optional, defaults to same as `gamma`) |
## negate
> negate([options]) ⇒ <code>Sharp</code>
Produce the "negative" of the image.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | |
| [options.alpha] | <code>Boolean</code> | <code>true</code> | Whether or not to negate any alpha channel |
**Example**
```js
const output = await sharp(input)
.negate()
.toBuffer();
```
**Example**
```js
const output = await sharp(input)
.negate({ alpha: false })
.toBuffer();
```
## normalise
> normalise([options]) ⇒ <code>Sharp</code>
Enhance output image contrast by stretching its luminance to cover a full dynamic range.
Uses a histogram-based approach, taking a default range of 1% to 99% to reduce sensitivity to noise at the extremes.
Luminance values below the `lower` percentile will be underexposed by clipping to zero.
Luminance values above the `upper` percentile will be overexposed by clipping to the max pixel value.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | |
| [options.lower] | <code>number</code> | <code>1</code> | Percentile below which luminance values will be underexposed. |
| [options.upper] | <code>number</code> | <code>99</code> | Percentile above which luminance values will be overexposed. |
**Example**
```js
const output = await sharp(input)
.normalise()
.toBuffer();
```
**Example**
```js
const output = await sharp(input)
.normalise({ lower: 0, upper: 100 })
.toBuffer();
```
## normalize
> normalize([options]) ⇒ <code>Sharp</code>
Alternative spelling of normalise.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | |
| [options.lower] | <code>number</code> | <code>1</code> | Percentile below which luminance values will be underexposed. |
| [options.upper] | <code>number</code> | <code>99</code> | Percentile above which luminance values will be overexposed. |
**Example**
```js
const output = await sharp(input)
.normalize()
.toBuffer();
```
## clahe
> clahe(options) ⇒ <code>Sharp</code>
Perform contrast limiting adaptive histogram equalization
[CLAHE](https://en.wikipedia.org/wiki/Adaptive_histogram_equalization#Contrast_Limited_AHE).
This will, in general, enhance the clarity of the image by bringing out darker details.
**Throws**:
- <code>Error</code> Invalid parameters
**Since**: 0.28.3
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| options | <code>Object</code> | | |
| options.width | <code>number</code> | | Integral width of the search window, in pixels. |
| options.height | <code>number</code> | | Integral height of the search window, in pixels. |
| [options.maxSlope] | <code>number</code> | <code>3</code> | Integral level of brightening, between 0 and 100, where 0 disables contrast limiting. |
**Example**
```js
const output = await sharp(input)
.clahe({
width: 3,
height: 3,
})
.toBuffer();
```
## convolve
> convolve(kernel) ⇒ <code>Sharp</code>
Convolve the image with the specified kernel.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| kernel | <code>Object</code> | | |
| kernel.width | <code>number</code> | | width of the kernel in pixels. |
| kernel.height | <code>number</code> | | height of the kernel in pixels. |
| kernel.kernel | <code>Array.<number></code> | | Array of length `width*height` containing the kernel values. |
| [kernel.scale] | <code>number</code> | <code>sum</code> | the scale of the kernel in pixels. |
| [kernel.offset] | <code>number</code> | <code>0</code> | the offset of the kernel in pixels. |
**Example**
```js
sharp(input)
.convolve({
width: 3,
height: 3,
kernel: [-1, 0, 1, -2, 0, 2, -1, 0, 1]
})
.raw()
.toBuffer(function(err, data, info) {
// data contains the raw pixel data representing the convolution
// of the input image with the horizontal Sobel operator
});
```
## threshold
> threshold([threshold], [options]) ⇒ <code>Sharp</code>
Any pixel value greater than or equal to the threshold value will be set to 255, otherwise it will be set to 0.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [threshold] | <code>number</code> | <code>128</code> | a value in the range 0-255 representing the level at which the threshold will be applied. |
| [options] | <code>Object</code> | | |
| [options.greyscale] | <code>Boolean</code> | <code>true</code> | convert to single channel greyscale. |
| [options.grayscale] | <code>Boolean</code> | <code>true</code> | alternative spelling for greyscale. |
## boolean
> boolean(operand, operator, [options]) ⇒ <code>Sharp</code>
Perform a bitwise boolean operation with operand image.
This operation creates an output image where each pixel is the result of
the selected bitwise boolean `operation` between the corresponding pixels of the input images.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Description |
| --- | --- | --- |
| operand | <code>Buffer</code> \| <code>string</code> | Buffer containing image data or string containing the path to an image file. |
| operator | <code>string</code> | one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively. |
| [options] | <code>Object</code> | |
| [options.raw] | <code>Object</code> | describes operand when using raw pixel data. |
| [options.raw.width] | <code>number</code> | |
| [options.raw.height] | <code>number</code> | |
| [options.raw.channels] | <code>number</code> | |
## linear
> linear([a], [b]) ⇒ <code>Sharp</code>
Apply the linear formula `a` * input + `b` to the image to adjust image levels.
When a single number is provided, it will be used for all image channels.
When an array of numbers is provided, the array length must match the number of channels.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [a] | <code>number</code> \| <code>Array.<number></code> | <code>[]</code> | multiplier |
| [b] | <code>number</code> \| <code>Array.<number></code> | <code>[]</code> | offset |
**Example**
```js
await sharp(input)
.linear(0.5, 2)
.toBuffer();
```
**Example**
```js
await sharp(rgbInput)
.linear(
[0.25, 0.5, 0.75],
[150, 100, 50]
)
.toBuffer();
```
## recomb
> recomb(inputMatrix) ⇒ <code>Sharp</code>
Recombine the image with the specified matrix.
**Throws**:
- <code>Error</code> Invalid parameters
**Since**: 0.21.1
| Param | Type | Description |
| --- | --- | --- |
| inputMatrix | <code>Array.<Array.<number>></code> | 3x3 or 4x4 Recombination matrix |
**Example**
```js
sharp(input)
.recomb([
[0.3588, 0.7044, 0.1368],
[0.2990, 0.5870, 0.1140],
[0.2392, 0.4696, 0.0912],
])
.raw()
.toBuffer(function(err, data, info) {
// data contains the raw pixel data after applying the matrix
// With this example input, a sepia filter has been applied
});
```
## modulate
> modulate([options]) ⇒ <code>Sharp</code>
Transforms the image using brightness, saturation, hue rotation, and lightness.
Brightness and lightness both operate on luminance, with the difference being that
brightness is multiplicative whereas lightness is additive.
**Since**: 0.22.1
| Param | Type | Description |
| --- | --- | --- |
| [options] | <code>Object</code> | |
| [options.brightness] | <code>number</code> | Brightness multiplier |
| [options.saturation] | <code>number</code> | Saturation multiplier |
| [options.hue] | <code>number</code> | Degrees for hue rotation |
| [options.lightness] | <code>number</code> | Lightness addend |
**Example**
```js
// increase brightness by a factor of 2
const output = await sharp(input)
.modulate({
brightness: 2
})
.toBuffer();
```
**Example**
```js
// hue-rotate by 180 degrees
const output = await sharp(input)
.modulate({
hue: 180
})
.toBuffer();
```
**Example**
```js
// increase lightness by +50
const output = await sharp(input)
.modulate({
lightness: 50
})
.toBuffer();
```
**Example**
```js
// decrease brightness and saturation while also hue-rotating by 90 degrees
const output = await sharp(input)
.modulate({
brightness: 0.5,
saturation: 0.5,
hue: 90,
})
.toBuffer();
```
================================================
FILE: docs/src/content/docs/api-output.md
================================================
---
# This file was auto-generated from JSDoc in lib/output.js
title: Output options
---
## toFile
> toFile(fileOut, [callback]) ⇒ <code>Promise.<Object></code>
Write output image data to a file.
If an explicit output format is not selected, it will be inferred from the extension,
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.
The caller is responsible for ensuring directory structures and permissions exist.
A `Promise` is returned when `callback` is not provided.
**Returns**: <code>Promise.<Object></code> - - when no callback is provided
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Description |
| --- | --- | --- |
| fileOut | <code>string</code> | the path to write the image data to. |
| [callback] | <code>function</code> | called on completion with two arguments `(err, info)`. `info` contains the output image `format`, `size` (bytes), `width`, `height`, `channels` and `premultiplied` (indicating if premultiplication was used). When using a crop strategy also contains `cropOffsetLeft` and `cropOffsetTop`. When using the attention crop strategy also contains `attentionX` and `attentionY`, the focal point of the cropped region. Animated output will also contain `pageHeight` and `pages`. May also contain `textAutofitDpi` (dpi the font was rendered at) if image was created from text. |
**Example**
```js
sharp(input)
.toFile('output.png', (err, info) => { ... });
```
**Example**
```js
sharp(input)
.toFile('output.png')
.then(info => { ... })
.catch(err => { ... });
```
## toBuffer
> toBuffer([options], [callback]) ⇒ <code>Promise.<Buffer></code>
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.
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.
`callback`, if present, gets three arguments `(err, data, info)` where:
- `err` is an error, if any.
- `data` is the output image data.
- `info` contains the output image `format`, `size` (bytes), `width`, `height`,
`channels` and `premultiplied` (indicating if premultiplication was used).
When using a crop strategy also contains `cropOffsetLeft` and `cropOffsetTop`.
Animated output will also contain `pageHeight` and `pages`.
May also contain `textAutofitDpi` (dpi the font was rendered at) if image was created from text.
A `Promise` is returned when `callback` is not provided.
**Returns**: <code>Promise.<Buffer></code> - - when no callback is provided
| Param | Type | Description |
| --- | --- | --- |
| [options] | <code>Object</code> | |
| [options.resolveWithObject] | <code>boolean</code> | Resolve the Promise with an Object containing `data` and `info` properties instead of resolving only with `data`. |
| [callback] | <code>function</code> | |
**Example**
```js
sharp(input)
.toBuffer((err, data, info) => { ... });
```
**Example**
```js
sharp(input)
.toBuffer()
.then(data => { ... })
.catch(err => { ... });
```
**Example**
```js
sharp(input)
.png()
.toBuffer({ resolveWithObject: true })
.then(({ data, info }) => { ... })
.catch(err => { ... });
```
**Example**
```js
const { data, info } = await sharp('my-image.jpg')
// output the raw pixels
.raw()
.toBuffer({ resolveWithObject: true });
// create a more type safe way to work with the raw pixel data
// this will not copy the data, instead it will change `data`s underlying ArrayBuffer
// so `data` and `pixelArray` point to the same memory location
const pixelArray = new Uint8ClampedArray(data.buffer);
// When you are done changing the pixelArray, sharp takes the `pixelArray` as an input
const { width, height, channels } = info;
await sharp(pixelArray, { raw: { width, height, channels } })
.toFile('my-changed-image.jpg');
```
## keepExif
> keepExif() ⇒ <code>Sharp</code>
Keep all EXIF metadata from the input image in the output image.
EXIF metadata is unsupported for TIFF output.
**Since**: 0.33.0
**Example**
```js
const outputWithExif = await sharp(inputWithExif)
.keepExif()
.toBuffer();
```
## withExif
> withExif(exif) ⇒ <code>Sharp</code>
Set EXIF metadata in the output image, ignoring any EXIF in the input image.
**Throws**:
- <code>Error</code> Invalid parameters
**Since**: 0.33.0
| Param | Type | Description |
| --- | --- | --- |
| exif | <code>Object.<string, Object.<string, string>></code> | Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data. |
**Example**
```js
const dataWithExif = await sharp(input)
.withExif({
IFD0: {
Copyright: 'The National Gallery'
},
IFD3: {
GPSLatitudeRef: 'N',
GPSLatitude: '51/1 30/1 3230/100',
GPSLongitudeRef: 'W',
GPSLongitude: '0/1 7/1 4366/100'
}
})
.toBuffer();
```
## withExifMerge
> withExifMerge(exif) ⇒ <code>Sharp</code>
Update EXIF metadata from the input image in the output image.
**Throws**:
- <code>Error</code> Invalid parameters
**Since**: 0.33.0
| Param | Type | Description |
| --- | --- | --- |
| exif | <code>Object.<string, Object.<string, string>></code> | Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data. |
**Example**
```js
const dataWithMergedExif = await sharp(inputWithExif)
.withExifMerge({
IFD0: {
Copyright: 'The National Gallery'
}
})
.toBuffer();
```
## keepIccProfile
> keepIccProfile() ⇒ <code>Sharp</code>
Keep ICC profile from the input image in the output image.
When input and output colour spaces differ, use with [toColourspace](/api-colour/#tocolourspace) and optionally [pipelineColourspace](/api-colour/#pipelinecolourspace).
**Since**: 0.33.0
**Example**
```js
const outputWithIccProfile = await sharp(inputWithIccProfile)
.keepIccProfile()
.toBuffer();
```
**Example**
```js
const cmykOutputWithIccProfile = await sharp(cmykInputWithIccProfile)
.pipelineColourspace('cmyk')
.toColourspace('cmyk')
.keepIccProfile()
.toBuffer();
```
## withIccProfile
> withIccProfile(icc, [options]) ⇒ <code>Sharp</code>
Transform using an ICC profile and attach to the output image.
This can either be an absolute filesystem path or
built-in profile name (`srgb`, `p3`, `cmyk`).
**Throws**:
- <code>Error</code> Invalid parameters
**Since**: 0.33.0
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| icc | <code>string</code> | | Absolute filesystem path to output ICC profile or built-in profile name (srgb, p3, cmyk). |
| [options] | <code>Object</code> | | |
| [options.attach] | <code>number</code> | <code>true</code> | Should the ICC profile be included in the output image metadata? |
**Example**
```js
const outputWithP3 = await sharp(input)
.withIccProfile('p3')
.toBuffer();
```
## keepXmp
> keepXmp() ⇒ <code>Sharp</code>
Keep XMP metadata from the input image in the output image.
**Since**: 0.34.3
**Example**
```js
const outputWithXmp = await sharp(inputWithXmp)
.keepXmp()
.toBuffer();
```
## withXmp
> withXmp(xmp) ⇒ <code>Sharp</code>
Set XMP metadata in the output image.
Supported by PNG, JPEG, WebP, and TIFF output.
**Throws**:
- <code>Error</code> Invalid parameters
**Since**: 0.34.3
| Param | Type | Description |
| --- | --- | --- |
| xmp | <code>string</code> | String containing XMP metadata to be embedded in the output image. |
**Example**
```js
const xmpString = `
<?xml version="1.0"?>
<x:xmpmeta xmlns:x="adobe:ns:meta/">
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
<rdf:Description rdf:about="" xmlns:dc="http://purl.org/dc/elements/1.1/">
<dc:creator><rdf:Seq><rdf:li>John Doe</rdf:li></rdf:Seq></dc:creator>
</rdf:Description>
</rdf:RDF>
</x:xmpmeta>`;
const data = await sharp(input)
.withXmp(xmpString)
.toBuffer();
```
## keepMetadata
> keepMetadata() ⇒ <code>Sharp</code>
Keep all metadata (EXIF, ICC, XMP, IPTC) from the input image in the output image.
The default behaviour, when `keepMetadata` is not used, is to convert to the device-independent
sRGB colour space and strip all metadata, including the removal of any ICC profile.
**Since**: 0.33.0
**Example**
```js
const outputWithMetadata = await sharp(inputWithMetadata)
.keepMetadata()
.toBuffer();
```
## withMetadata
> withMetadata([options]) ⇒ <code>Sharp</code>
Keep most metadata (EXIF, XMP, IPTC) from the input image in the output image.
This will also convert to and add a web-friendly sRGB ICC profile if appropriate.
Allows orientation and density to be set or updated.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Description |
| --- | --- | --- |
| [options] | <code>Object</code> | |
| [options.orientation] | <code>number</code> | Used to update the EXIF `Orientation` tag, integer between 1 and 8. |
| [options.density] | <code>number</code> | Number of pixels per inch (DPI). |
**Example**
```js
const outputSrgbWithMetadata = await sharp(inputRgbWithMetadata)
.withMetadata()
.toBuffer();
```
**Example**
```js
// Set output metadata to 96 DPI
const data = await sharp(input)
.withMetadata({ density: 96 })
.toBuffer();
```
## toFormat
> toFormat(format, options) ⇒ <code>Sharp</code>
Force output to a given format.
**Throws**:
- <code>Error</code> unsupported format or options
| Param | Type | Description |
| --- | --- | --- |
| format | <code>string</code> \| <code>Object</code> | as a string or an Object with an 'id' attribute |
| options | <code>Object</code> | output options |
**Example**
```js
// Convert any input to PNG output
const data = await sharp(input)
.toFormat('png')
.toBuffer();
```
## jpeg
> jpeg([options]) ⇒ <code>Sharp</code>
Use these JPEG options for output image.
**Throws**:
- <code>Error</code> Invalid options
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | output options |
| [options.quality] | <code>number</code> | <code>80</code> | quality, integer 1-100 |
| [options.progressive] | <code>boolean</code> | <code>false</code> | use progressive (interlace) scan |
| [options.chromaSubsampling] | <code>string</code> | <code>"'4:2:0'"</code> | set to '4:4:4' to prevent chroma subsampling otherwise defaults to '4:2:0' chroma subsampling |
| [options.optimiseCoding] | <code>boolean</code> | <code>true</code> | optimise Huffman coding tables |
| [options.optimizeCoding] | <code>boolean</code> | <code>true</code> | alternative spelling of optimiseCoding |
| [options.mozjpeg] | <code>boolean</code> | <code>false</code> | use mozjpeg defaults, equivalent to `{ trellisQuantisation: true, overshootDeringing: true, optimiseScans: true, quantisationTable: 3 }` |
| [options.trellisQuantisation] | <code>boolean</code> | <code>false</code> | apply trellis quantisation |
| [options.overshootDeringing] | <code>boolean</code> | <code>false</code> | apply overshoot deringing |
| [options.optimiseScans] | <code>boolean</code> | <code>false</code> | optimise progressive scans, forces progressive |
| [options.optimizeScans] | <code>boolean</code> | <code>false</code> | alternative spelling of optimiseScans |
| [options.quantisationTable] | <code>number</code> | <code>0</code> | quantization table to use, integer 0-8 |
| [options.quantizationTable] | <code>number</code> | <code>0</code> | alternative spelling of quantisationTable |
| [options.force] | <code>boolean</code> | <code>true</code> | force JPEG output, otherwise attempt to use input format |
**Example**
```js
// Convert any input to very high quality JPEG output
const data = await sharp(input)
.jpeg({
quality: 100,
chromaSubsampling: '4:4:4'
})
.toBuffer();
```
**Example**
```js
// Use mozjpeg to reduce output JPEG file size (slower)
const data = await sharp(input)
.jpeg({ mozjpeg: true })
.toBuffer();
```
## png
> png([options]) ⇒ <code>Sharp</code>
Use these PNG options for output image.
By default, PNG output is full colour at 8 bits per pixel.
Indexed PNG input at 1, 2 or 4 bits per pixel is converted to 8 bits per pixel.
Set `palette` to `true` for slower, indexed PNG output.
For 16 bits per pixel output, convert to `rgb16` via
[toColourspace](/api-colour/#tocolourspace).
**Throws**:
- <code>Error</code> Invalid options
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | |
| [options.progressive] | <code>boolean</code> | <code>false</code> | use progressive (interlace) scan |
| [options.compressionLevel] | <code>number</code> | <code>6</code> | zlib compression level, 0 (fastest, largest) to 9 (slowest, smallest) |
| [options.adaptiveFiltering] | <code>boolean</code> | <code>false</code> | use adaptive row filtering |
| [options.palette] | <code>boolean</code> | <code>false</code> | quantise to a palette-based image with alpha transparency support |
| [options.quality] | <code>number</code> | <code>100</code> | use the lowest number of colours needed to achieve given quality, sets `palette` to `true` |
| [options.effort] | <code>number</code> | <code>7</code> | CPU effort, between 1 (fastest) and 10 (slowest), sets `palette` to `true` |
| [options.colours] | <code>number</code> | <code>256</code> | maximum number of palette entries, sets `palette` to `true` |
| [options.colors] | <code>number</code> | <code>256</code> | alternative spelling of `options.colours`, sets `palette` to `true` |
| [options.dither] | <code>number</code> | <code>1.0</code> | level of Floyd-Steinberg error diffusion, sets `palette` to `true` |
| [options.force] | <code>boolean</code> | <code>true</code> | force PNG output, otherwise attempt to use input format |
**Example**
```js
// Convert any input to full colour PNG output
const data = await sharp(input)
.png()
.toBuffer();
```
**Example**
```js
// Convert any input to indexed PNG output (slower)
const data = await sharp(input)
.png({ palette: true })
.toBuffer();
```
**Example**
```js
// Output 16 bits per pixel RGB(A)
const data = await sharp(input)
.toColourspace('rgb16')
.png()
.toBuffer();
```
## webp
> webp([options]) ⇒ <code>Sharp</code>
Use these WebP options for output image.
**Throws**:
- <code>Error</code> Invalid options
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | output options |
| [options.quality] | <code>number</code> | <code>80</code> | quality, integer 1-100 |
| [options.alphaQuality] | <code>number</code> | <code>100</code> | quality of alpha layer, integer 0-100 |
| [options.lossless] | <code>boolean</code> | <code>false</code> | use lossless compression mode |
| [options.nearLossless] | <code>boolean</code> | <code>false</code> | use near_lossless compression mode |
| [options.smartSubsample] | <code>boolean</code> | <code>false</code> | use high quality chroma subsampling |
| [options.smartDeblock] | <code>boolean</code> | <code>false</code> | auto-adjust the deblocking filter, can improve low contrast edges (slow) |
| [options.preset] | <code>string</code> | <code>"'default'"</code> | named preset for preprocessing/filtering, one of: default, photo, picture, drawing, icon, text |
| [options.effort] | <code>number</code> | <code>4</code> | CPU effort, between 0 (fastest) and 6 (slowest) |
| [options.loop] | <code>number</code> | <code>0</code> | number of animation iterations, use 0 for infinite animation |
| [options.delay] | <code>number</code> \| <code>Array.<number></code> | | delay(s) between animation frames (in milliseconds) |
| [options.minSize] | <code>boolean</code> | <code>false</code> | prevent use of animation key frames to minimise file size (slow) |
| [options.mixed] | <code>boolean</code> | <code>false</code> | allow mixture of lossy and lossless animation frames (slow) |
| [options.force] | <code>boolean</code> | <code>true</code> | force WebP output, otherwise attempt to use input format |
**Example**
```js
// Convert any input to lossless WebP output
const data = await sharp(input)
.webp({ lossless: true })
.toBuffer();
```
**Example**
```js
// Optimise the file size of an animated WebP
const outputWebp = await sharp(inputWebp, { animated: true })
.webp({ effort: 6 })
.toBuffer();
```
## gif
> gif([options]) ⇒ <code>Sharp</code>
Use these GIF options for the output image.
The first entry in the palette is reserved for transparency.
The palette of the input image will be re-used if possible.
**Throws**:
- <code>Error</code> Invalid options
**Since**: 0.30.0
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | output options |
| [options.reuse] | <code>boolean</code> | <code>true</code> | re-use existing palette, otherwise generate new (slow) |
| [options.progressive] | <code>boolean</code> | <code>false</code> | use progressive (interlace) scan |
| [options.colours] | <code>number</code> | <code>256</code> | maximum number of palette entries, including transparency, between 2 and 256 |
| [options.colors] | <code>number</code> | <code>256</code> | alternative spelling of `options.colours` |
| [options.effort] | <code>number</code> | <code>7</code> | CPU effort, between 1 (fastest) and 10 (slowest) |
| [options.dither] | <code>number</code> | <code>1.0</code> | level of Floyd-Steinberg error diffusion, between 0 (least) and 1 (most) |
| [options.interFrameMaxError] | <code>number</code> | <code>0</code> | maximum inter-frame error for transparency, between 0 (lossless) and 32 |
| [options.interPaletteMaxError] | <code>number</code> | <code>3</code> | maximum inter-palette error for palette reuse, between 0 and 256 |
| [options.keepDuplicateFrames] | <code>boolean</code> | <code>false</code> | keep duplicate frames in the output instead of combining them |
| [options.loop] | <code>number</code> | <code>0</code> | number of animation iterations, use 0 for infinite animation |
| [options.delay] | <code>number</code> \| <code>Array.<number></code> | | delay(s) between animation frames (in milliseconds) |
| [options.force] | <code>boolean</code> | <code>true</code> | force GIF output, otherwise attempt to use input format |
**Example**
```js
// Convert PNG to GIF
await sharp(pngBuffer)
.gif()
.toBuffer();
```
**Example**
```js
// Convert animated WebP to animated GIF
await sharp('animated.webp', { animated: true })
.toFile('animated.gif');
```
**Example**
```js
// Create a 128x128, cropped, non-dithered, animated thumbnail of an animated GIF
const out = await sharp('in.gif', { animated: true })
.resize({ width: 128, height: 128 })
.gif({ dither: 0 })
.toBuffer();
```
**Example**
```js
// Lossy file size reduction of animated GIF
await sharp('in.gif', { animated: true })
.gif({ interFrameMaxError: 8 })
.toFile('optim.gif');
```
## jp2
> jp2([options]) ⇒ <code>Sharp</code>
Use these JP2 options for output image.
Requires libvips compiled with support for OpenJPEG.
The prebuilt binaries do not include this - see
[installing a custom libvips](/install#custom-libvips).
**Throws**:
- <code>Error</code> Invalid options
**Since**: 0.29.1
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | output options |
| [options.quality] | <code>number</code> | <code>80</code> | quality, integer 1-100 |
| [options.lossless] | <code>boolean</code> | <code>false</code> | use lossless compression mode |
| [options.tileWidth] | <code>number</code> | <code>512</code> | horizontal tile size |
| [options.tileHeight] | <code>number</code> | <code>512</code> | vertical tile size |
| [options.chromaSubsampling] | <code>string</code> | <code>"'4:4:4'"</code> | set to '4:2:0' to use chroma subsampling |
**Example**
```js
// Convert any input to lossless JP2 output
const data = await sharp(input)
.jp2({ lossless: true })
.toBuffer();
```
**Example**
```js
// Convert any input to very high quality JP2 output
const data = await sharp(input)
.jp2({
quality: 100,
chromaSubsampling: '4:4:4'
})
.toBuffer();
```
## tiff
> tiff([options]) ⇒ <code>Sharp</code>
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.
**Throws**:
- <code>Error</code> Invalid options
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | output options |
| [options.quality] | <code>number</code> | <code>80</code> | quality, integer 1-100 |
| [options.force] | <code>boolean</code> | <code>true</code> | force TIFF output, otherwise attempt to use input format |
| [options.compression] | <code>string</code> | <code>"'jpeg'"</code> | compression options: none, jpeg, deflate, packbits, ccittfax4, lzw, webp, zstd, jp2k |
| [options.bigtiff] | <code>boolean</code> | <code>false</code> | use BigTIFF variant (has no effect when compression is none) |
| [options.predictor] | <code>string</code> | <code>"'horizontal'"</code> | compression predictor options: none, horizontal, float |
| [options.pyramid] | <code>boolean</code> | <code>false</code> | write an image pyramid |
| [options.tile] | <code>boolean</code> | <code>false</code> | write a tiled tiff |
| [options.tileWidth] | <code>number</code> | <code>256</code> | horizontal tile size |
| [options.tileHeight] | <code>number</code> | <code>256</code> | vertical tile size |
| [options.xres] | <code>number</code> | <code>1.0</code> | horizontal resolution in pixels/mm |
| [options.yres] | <code>number</code> | <code>1.0</code> | vertical resolution in pixels/mm |
| [options.resolutionUnit] | <code>string</code> | <code>"'inch'"</code> | resolution unit options: inch, cm |
| [options.bitdepth] | <code>number</code> | <code>8</code> | reduce bitdepth to 1, 2 or 4 bit |
| [options.miniswhite] | <code>boolean</code> | <code>false</code> | write 1-bit images as miniswhite |
**Example**
```js
// Convert SVG input to LZW-compressed, 1 bit per pixel TIFF output
sharp('input.svg')
.tiff({
compression: 'lzw',
bitdepth: 1
})
.toFile('1-bpp-output.tiff')
.then(info => { ... });
```
## avif
> avif([options]) ⇒ <code>Sharp</code>
Use these AVIF options for output image.
AVIF image sequences are not supported.
Prebuilt binaries support a bitdepth of 8 only.
This feature is experimental on the Windows ARM64 platform
and requires a CPU with ARM64v8.4 or later.
**Throws**:
- <code>Error</code> Invalid options
**Since**: 0.27.0
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | output options |
| [options.quality] | <code>number</code> | <code>50</code> | quality, integer 1-100 |
| [options.lossless] | <code>boolean</code> | <code>false</code> | use lossless compression |
| [options.effort] | <code>number</code> | <code>4</code> | CPU effort, between 0 (fastest) and 9 (slowest) |
| [options.chromaSubsampling] | <code>string</code> | <code>"'4:4:4'"</code> | set to '4:2:0' to use chroma subsampling |
| [options.bitdepth] | <code>number</code> | <code>8</code> | set bitdepth to 8, 10 or 12 bit |
**Example**
```js
const data = await sharp(input)
.avif({ effort: 2 })
.toBuffer();
```
**Example**
```js
const data = await sharp(input)
.avif({ lossless: true })
.toBuffer();
```
## heif
> heif(options) ⇒ <code>Sharp</code>
Use these HEIF options for output image.
Support for patent-encumbered HEIC images using `hevc` compression requires the use of a
globally-installed libvips compiled with support for libheif, libde265 and x265.
**Throws**:
- <code>Error</code> Invalid options
**Since**: 0.23.0
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| options | <code>Object</code> | | output options |
| options.compression | <code>string</code> | | compression format: av1, hevc |
| [options.quality] | <code>number</code> | <code>50</code> | quality, integer 1-100 |
| [options.lossless] | <code>boolean</code> | <code>false</code> | use lossless compression |
| [options.effort] | <code>number</code> | <code>4</code> | CPU effort, between 0 (fastest) and 9 (slowest) |
| [options.chromaSubsampling] | <code>string</code> | <code>"'4:4:4'"</code> | set to '4:2:0' to use chroma subsampling |
| [options.bitdepth] | <code>number</code> | <code>8</code> | set bitdepth to 8, 10 or 12 bit |
**Example**
```js
const data = await sharp(input)
.heif({ compression: 'hevc' })
.toBuffer();
```
## jxl
> jxl([options]) ⇒ <code>Sharp</code>
Use these JPEG-XL (JXL) options for output image.
This feature is experimental, please do not use in production systems.
Requires libvips compiled with support for libjxl.
The prebuilt binaries do not include this - see
[installing a custom libvips](/install/#custom-libvips).
**Throws**:
- <code>Error</code> Invalid options
**Since**: 0.31.3
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | output options |
| [options.distance] | <code>number</code> | <code>1.0</code> | maximum encoding error, between 0 (highest quality) and 15 (lowest quality) |
| [options.quality] | <code>number</code> | | calculate `distance` based on JPEG-like quality, between 1 and 100, overrides distance if specified |
| [options.decodingTier] | <code>number</code> | <code>0</code> | target decode speed tier, between 0 (highest quality) and 4 (lowest quality) |
| [options.lossless] | <code>boolean</code> | <code>false</code> | use lossless compression |
| [options.effort] | <code>number</code> | <code>7</code> | CPU effort, between 1 (fastest) and 9 (slowest) |
| [options.loop] | <code>number</code> | <code>0</code> | number of animation iterations, use 0 for infinite animation |
| [options.delay] | <code>number</code> \| <code>Array.<number></code> | | delay(s) between animation frames (in milliseconds) |
## raw
> raw([options]) ⇒ <code>Sharp</code>
Force output to be raw, uncompressed pixel data.
Pixel ordering is left-to-right, top-to-bottom, without padding.
Channel ordering will be RGB or RGBA for non-greyscale colourspaces.
**Throws**:
- <code>Error</code> Invalid options
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | output options |
| [options.depth] | <code>string</code> | <code>"'uchar'"</code> | bit depth, one of: char, uchar (default), short, ushort, int, uint, float, complex, double, dpcomplex |
**Example**
```js
// Extract raw, unsigned 8-bit RGB pixel data from JPEG input
const { data, info } = await sharp('input.jpg')
.raw()
.toBuffer({ resolveWithObject: true });
```
**Example**
```js
// Extract alpha channel as raw, unsigned 16-bit pixel data from PNG input
const data = await sharp('input.png')
.ensureAlpha()
.extractChannel(3)
.toColourspace('b-w')
.raw({ depth: 'ushort' })
.toBuffer();
```
## tile
> tile([options]) ⇒ <code>Sharp</code>
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.
The container will be set to `zip` when the output is a Buffer or Stream, otherwise it will default to `fs`.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | |
| [options.size] | <code>number</code> | <code>256</code> | tile size in pixels, a value between 1 and 8192. |
| [options.overlap] | <code>number</code> | <code>0</code> | tile overlap in pixels, a value between 0 and 8192. |
| [options.angle] | <code>number</code> | <code>0</code> | tile angle of rotation, must be a multiple of 90. |
| [options.background] | <code>string</code> \| <code>Object</code> | <code>"{r: 255, g: 255, b: 255, alpha: 1}"</code> | background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to white without transparency. |
| [options.depth] | <code>string</code> | | how deep to make the pyramid, possible values are `onepixel`, `onetile` or `one`, default based on layout. |
| [options.skipBlanks] | <code>number</code> | <code>-1</code> | Threshold to skip tile generation. Range is 0-255 for 8-bit images, 0-65535 for 16-bit images. Default is 5 for `google` layout, -1 (no skip) otherwise. |
| [options.container] | <code>string</code> | <code>"'fs'"</code> | tile container, with value `fs` (filesystem) or `zip` (compressed file). |
| [options.layout] | <code>string</code> | <code>"'dz'"</code> | filesystem layout, possible values are `dz`, `iiif`, `iiif3`, `zoomify` or `google`. |
| [options.centre] | <code>boolean</code> | <code>false</code> | centre image in tile. |
| [options.center] | <code>boolean</code> | <code>false</code> | alternative spelling of centre. |
| [options.id] | <code>string</code> | <code>"'https://example.com/iiif'"</code> | when `layout` is `iiif`/`iiif3`, sets the `@id`/`id` attribute of `info.json` |
| [options.basename] | <code>string</code> | | the name of the directory within the zip file when container is `zip`. |
**Example**
```js
sharp('input.tiff')
.png()
.tile({
size: 512
})
.toFile('output.dz', function(err, info) {
// output.dzi is the Deep Zoom XML definition
// output_files contains 512x512 tiles grouped by zoom level
});
```
**Example**
```js
const zipFileWithTiles = await sharp(input)
.tile({ basename: "tiles" })
.toBuffer();
```
**Example**
```js
const iiififier = sharp().tile({ layout: "iiif" });
readableStream
.pipe(iiififier)
.pipe(writeableStream);
```
## timeout
> timeout(options) ⇒ <code>Sharp</code>
Set a timeout for processing, in seconds.
Use a value of zero to continue processing indefinitely, the default behaviour.
The clock starts when libvips opens an input image for processing.
Time spent waiting for a libuv thread to become available is not included.
**Since**: 0.29.2
| Param | Type | Description |
| --- | --- | --- |
| options | <code>Object</code> | |
| options.seconds | <code>number</code> | Number of seconds after which processing will be stopped |
**Example**
```js
// Ensure processing takes no longer than 3 seconds
try {
const data = await sharp(input)
.blur(1000)
.timeout({ seconds: 3 })
.toBuffer();
} catch (err) {
if (err.message.includes('timeout')) { ... }
}
```
================================================
FILE: docs/src/content/docs/api-resize.md
================================================
---
# This file was auto-generated from JSDoc in lib/resize.js
title: Resizing images
---
## resize
> resize([width], [height], [options]) ⇒ <code>Sharp</code>
Resize image to `width`, `height` or `width x height`.
When both a `width` and `height` are provided, the possible methods by which the image should **fit** these are:
- `cover`: (default) Preserving aspect ratio, attempt to ensure the image covers both provided dimensions by cropping/clipping to fit.
- `contain`: Preserving aspect ratio, contain within both provided dimensions using "letterboxing" where necessary.
- `fill`: Ignore the aspect ratio of the input and stretch to both provided dimensions.
- `inside`: Preserving aspect ratio, resize the image to be as large as possible while ensuring its dimensions are less than or equal to both those specified.
- `outside`: Preserving aspect ratio, resize the image to be as small as possible while ensuring its dimensions are greater than or equal to both those specified.
Some of these values are based on the [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit) CSS property.
<img alt="Examples of various values for the fit property when resizing" width="100%" style="aspect-ratio: 998/243" src="/api-resize-fit.svg">
When using a **fit** of `cover` or `contain`, the default **position** is `centre`. Other options are:
- `sharp.position`: `top`, `right top`, `right`, `right bottom`, `bottom`, `left bottom`, `left`, `left top`.
- `sharp.gravity`: `north`, `northeast`, `east`, `southeast`, `south`, `southwest`, `west`, `northwest`, `center` or `centre`.
- `sharp.strategy`: `cover` only, dynamically crop using either the `entropy` or `attention` strategy.
Some of these values are based on the [object-position](https://developer.mozilla.org/en-US/docs/Web/CSS/object-position) CSS property.
The strategy-based approach initially resizes so one dimension is at its target length
then repeatedly ranks edge regions, discarding the edge with the lowest score based on the selected strategy.
- `entropy`: focus on the region with the highest [Shannon entropy](https://en.wikipedia.org/wiki/Entropy_%28information_theory%29).
- `attention`: focus on the region with the highest luminance frequency, colour saturation and presence of skin tones.
Possible downsizing kernels are:
- `nearest`: Use [nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation).
- `linear`: Use a [triangle filter](https://en.wikipedia.org/wiki/Triangular_function).
- `cubic`: Use a [Catmull-Rom spline](https://en.wikipedia.org/wiki/Centripetal_Catmull%E2%80%93Rom_spline).
- `mitchell`: Use a [Mitchell-Netravali spline](https://www.cs.utexas.edu/~fussell/courses/cs384g-fall2013/lectures/mitchell/Mitchell.pdf).
- `lanczos2`: Use a [Lanczos kernel](https://en.wikipedia.org/wiki/Lanczos_resampling#Lanczos_kernel) with `a=2`.
- `lanczos3`: Use a Lanczos kernel with `a=3` (the default).
- `mks2013`: Use a [Magic Kernel Sharp](https://johncostella.com/magic/mks.pdf) 2013 kernel, as adopted by Facebook.
- `mks2021`: Use a Magic Kernel Sharp 2021 kernel, with more accurate (reduced) sharpening than the 2013 version.
When upsampling, these kernels map to `nearest`, `linear` and `cubic` interpolators.
Downsampling kernels without a matching upsampling interpolator map to `cubic`.
Only one resize can occur per pipeline.
Previous calls to `resize` in the same pipeline will be ignored.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [width] | <code>number</code> | | How many pixels wide the resultant image should be. Use `null` or `undefined` to auto-scale the width to match the height. |
| [height] | <code>number</code> | | How many pixels high the resultant image should be. Use `null` or `undefined` to auto-scale the height to match the width. |
| [options] | <code>Object</code> | | |
| [options.width] | <code>number</code> | | An alternative means of specifying `width`. If both are present this takes priority. |
| [options.height] | <code>number</code> | | An alternative means of specifying `height`. If both are present this takes priority. |
| [options.fit] | <code>String</code> | <code>'cover'</code> | How the image should be resized/cropped to fit the target dimension(s), one of `cover`, `contain`, `fill`, `inside` or `outside`. |
| [options.position] | <code>String</code> | <code>'centre'</code> | A position, gravity or strategy to use when `fit` is `cover` or `contain`. |
| [options.background] | <code>String</code> \| <code>Object</code> | <code>{r: 0, g: 0, b: 0, alpha: 1}</code> | background colour when `fit` is `contain`, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to black without transparency. |
| [options.kernel] | <code>String</code> | <code>'lanczos3'</code> | The kernel to use for image reduction and the inferred interpolator to use for upsampling. Use the `fastShrinkOnLoad` option to control kernel vs shrink-on-load. |
| [options.withoutEnlargement] | <code>Boolean</code> | <code>false</code> | Do not scale up if the width *or* height are already less than the target dimensions, equivalent to GraphicsMagick's `>` geometry option. This may result in output dimensions smaller than the target dimensions. |
| [options.withoutReduction] | <code>Boolean</code> | <code>false</code> | Do not scale down if the width *or* height are already greater than the target dimensions, equivalent to GraphicsMagick's `<` geometry option. This may still result in a crop to reach the target dimensions. |
| [options.fastShrinkOnLoad] | <code>Boolean</code> | <code>true</code> | Take greater advantage of the JPEG and WebP shrink-on-load feature, which can lead to a slight moiré pattern or round-down of an auto-scaled dimension. |
**Example**
```js
sharp(input)
.resize({ width: 100 })
.toBuffer()
.then(data => {
// 100 pixels wide, auto-scaled height
});
```
**Example**
```js
sharp(input)
.resize({ height: 100 })
.toBuffer()
.then(data => {
// 100 pixels high, auto-scaled width
});
```
**Example**
```js
sharp(input)
.resize(200, 300, {
kernel: sharp.kernel.nearest,
fit: 'contain',
position: 'right top',
background: { r: 255, g: 255, b: 255, alpha: 0.5 }
})
.toFile('output.png')
.then(() => {
// output.png is a 200 pixels wide and 300 pixels high image
// containing a nearest-neighbour scaled version
// contained within the north-east corner of a semi-transparent white canvas
});
```
**Example**
```js
const transformer = sharp()
.resize({
width: 200,
height: 200,
fit: sharp.fit.cover,
position: sharp.strategy.entropy
});
// Read image data from readableStream
// Write 200px square auto-cropped image data to writableStream
readableStream
.pipe(transformer)
.pipe(writableStream);
```
**Example**
```js
sharp(input)
.resize(200, 200, {
fit: sharp.fit.inside,
withoutEnlargement: true
})
.toFormat('jpeg')
.toBuffer()
.then(function(outputBuffer) {
// outputBuffer contains JPEG image data
// no wider and no higher than 200 pixels
// and no larger than the input image
});
```
**Example**
```js
sharp(input)
.resize(200, 200, {
fit: sharp.fit.outside,
withoutReduction: true
})
.toFormat('jpeg')
.toBuffer()
.then(function(outputBuffer) {
// outputBuffer contains JPEG image data
// of at least 200 pixels wide and 200 pixels high while maintaining aspect ratio
// and no smaller than the input image
});
```
**Example**
```js
const scaleByHalf = await sharp(input)
.metadata()
.then(({ width }) => sharp(input)
.resize(Math.round(width * 0.5))
.toBuffer()
);
```
## extend
> extend(extend) ⇒ <code>Sharp</code>
Extend / pad / extrude one or more edges of the image with either
the provided background colour or pixels derived from the image.
This operation will always occur after resizing and extraction, if any.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| extend | <code>number</code> \| <code>Object</code> | | single pixel count to add to all edges or an Object with per-edge counts |
| [extend.top] | <code>number</code> | <code>0</code> | |
| [extend.left] | <code>number</code> | <code>0</code> | |
| [extend.bottom] | <code>number</code> | <code>0</code> | |
| [extend.right] | <code>number</code> | <code>0</code> | |
| [extend.extendWith] | <code>String</code> | <code>'background'</code> | populate new pixels using this method, one of: background, copy, repeat, mirror. |
| [extend.background] | <code>String</code> \| <code>Object</code> | <code>{r: 0, g: 0, b: 0, alpha: 1}</code> | background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to black without transparency. |
**Example**
```js
// Resize to 140 pixels wide, then add 10 transparent pixels
// to the top, left and right edges and 20 to the bottom edge
sharp(input)
.resize(140)
.extend({
top: 10,
bottom: 20,
left: 10,
right: 10,
background: { r: 0, g: 0, b: 0, alpha: 0 }
})
...
```
**Example**
```js
// Add a row of 10 red pixels to the bottom
sharp(input)
.extend({
bottom: 10,
background: 'red'
})
...
```
**Example**
```js
// Extrude image by 8 pixels to the right, mirroring existing right hand edge
sharp(input)
.extend({
right: 8,
background: 'mirror'
})
...
```
## extract
> extract(options) ⇒ <code>Sharp</code>
Extract/crop a region of the image.
- Use `extract` before `resize` for pre-resize extraction.
- Use `extract` after `resize` for post-resize extraction.
- Use `extract` twice and `resize` once for extract-then-resize-then-extract in a fixed operation order.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Description |
| --- | --- | --- |
| options | <code>Object</code> | describes the region to extract using integral pixel values |
| options.left | <code>number</code> | zero-indexed offset from left edge |
| options.top | <code>number</code> | zero-indexed offset from top edge |
| options.width | <code>number</code> | width of region to extract |
| options.height | <code>number</code> | height of region to extract |
**Example**
```js
sharp(input)
.extract({ left: left, top: top, width: width, height: height })
.toFile(output, function(err) {
// Extract a region of the input image, saving in the same format.
});
```
**Example**
```js
sharp(input)
.extract({ left: leftOffsetPre, top: topOffsetPre, width: widthPre, height: heightPre })
.resize(width, height)
.extract({ left: leftOffsetPost, top: topOffsetPost, width: widthPost, height: heightPost })
.toFile(output, function(err) {
// Extract a region, resize, then extract from the resized image
});
```
## trim
> trim([options]) ⇒ <code>Sharp</code>
Trim pixels from all edges that contain values similar to the given background colour, which defaults to that of the top-left pixel.
Images with an alpha channel will use the combined bounding box of alpha and non-alpha channels.
If the result of this operation would trim an image to nothing then no change is made.
The `info` response Object will contain `trimOffsetLeft` and `trimOffsetTop` properties.
**Throws**:
- <code>Error</code> Invalid parameters
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | |
| [options.background] | <code>string</code> \| <code>Object</code> | <code>"'top-left pixel'"</code> | Background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to that of the top-left pixel. |
| [options.threshold] | <code>number</code> | <code>10</code> | Allowed difference from the above colour, a positive number. |
| [options.lineArt] | <code>boolean</code> | <code>false</code> | Does the input more closely resemble line art (e.g. vector) rather than being photographic? |
**Example**
```js
// Trim pixels with a colour similar to that of the top-left pixel.
await sharp(input)
.trim()
.toFile(output);
```
**Example**
```js
// Trim pixels with the exact same colour as that of the top-left pixel.
await sharp(input)
.trim({
threshold: 0
})
.toFile(output);
```
**Example**
```js
// Assume input is line art and trim only pixels with a similar colour to red.
const output = await sharp(input)
.trim({
background: "#FF0000",
lineArt: true
})
.toBuffer();
```
**Example**
```js
// Trim all "yellow-ish" pixels, being more lenient with the higher threshold.
const output = await sharp(input)
.trim({
background: "yellow",
threshold: 42,
})
.toBuffer();
```
================================================
FILE: docs/src/content/docs/api-utility.md
================================================
---
# This file was auto-generated from JSDoc in lib/utility.js
title: Global properties
---
## versions
> versions
An Object containing the version numbers of sharp, libvips
and (when using prebuilt binaries) its dependencies.
**Example**
```js
console.log(sharp.versions);
```
## interpolators
> interpolators : <code>enum</code>
An Object containing the available interpolators and their proper values
**Read only**: true
**Properties**
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| nearest | <code>string</code> | <code>"nearest"</code> | [Nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation). Suitable for image enlargement only. |
| bilinear | <code>string</code> | <code>"bilinear"</code> | [Bilinear interpolation](http://en.wikipedia.org/wiki/Bilinear_interpolation). Faster than bicubic but with less smooth results. |
| bicubic | <code>string</code> | <code>"bicubic"</code> | [Bicubic interpolation](http://en.wikipedia.org/wiki/Bicubic_interpolation) (the default). |
| locallyBoundedBicubic | <code>string</code> | <code>"lbb"</code> | [LBB interpolation](https://github.com/libvips/libvips/blob/master/libvips/resample/lbb.cpp#L100). Prevents some "[acutance](http://en.wikipedia.org/wiki/Acutance)" but typically reduces performance by a factor of 2. |
| nohalo | <code>string</code> | <code>"nohalo"</code> | [Nohalo interpolation](http://eprints.soton.ac.uk/268086/). Prevents acutance but typically reduces performance by a factor of 3. |
| vertexSplitQuadraticBasisSpline | <code>string</code> | <code>"vsqbs"</code> | [VSQBS interpolation](https://github.com/libvips/libvips/blob/master/libvips/resample/vsqbs.cpp#L48). Prevents "staircasing" when enlarging. |
## format
> format ⇒ <code>Object</code>
An Object containing nested boolean values representing the available input and output formats/methods.
**Example**
```js
console.log(sharp.format);
```
## queue
> queue
An EventEmitter that emits a `change` event when a task is either:
- queued, waiting for _libuv_ to provide a worker thread
- complete
**Example**
```js
sharp.queue.on('change', function(queueLength) {
console.log('Queue contains ' + queueLength + ' task(s)');
});
```
## cache
> cache([options]) ⇒ <code>Object</code>
Gets or, when options are provided, sets the limits of _libvips'_ operation cache.
Existing entries in the cache will be trimmed after any change in limits.
This method always returns cache statistics,
useful for determining how much working memory is required for a particular task.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> \| <code>boolean</code> | <code>true</code> | Object with the following attributes, or boolean where true uses default cache settings and false removes all caching |
| [options.memory] | <code>number</code> | <code>50</code> | is the maximum memory in MB to use for this cache |
| [options.files] | <code>number</code> | <code>20</code> | is the maximum number of files to hold open |
| [options.items] | <code>number</code> | <code>100</code> | is the maximum number of operations to cache |
**Example**
```js
const stats = sharp.cache();
```
**Example**
```js
sharp.cache( { items: 200 } );
sharp.cache( { files: 0 } );
sharp.cache(false);
```
## concurrency
> concurrency([concurrency]) ⇒ <code>number</code>
Gets or, when a concurrency is provided, sets
the maximum number of threads _libvips_ should use to process _each image_.
These are from a thread pool managed by glib,
which helps avoid the overhead of creating new threads.
This method always returns the current concurrency.
The default value is the number of CPU cores,
except when using glibc-based Linux without jemalloc,
where the default is `1` to help reduce memory fragmentation.
A value of `0` will reset this to the number of CPU cores.
Some image format libraries spawn additional threads,
e.g. libaom manages its own 4 threads when encoding AVIF images,
and these are independent of the value set here.
:::note
Further [control over performance](/performance/) is available.
:::
**Returns**: <code>number</code> - concurrency
| Param | Type |
| --- | --- |
| [concurrency] | <code>number</code> |
**Example**
```js
const threads = sharp.concurrency(); // 4
sharp.concurrency(2); // 2
sharp.concurrency(0); // 4
```
## counters
> counters() ⇒ <code>Object</code>
Provides access to internal task counters.
- queue is the number of tasks this module has queued waiting for _libuv_ to provide a worker thread from its pool.
- process is the number of resize tasks currently being processed.
**Example**
```js
const counters = sharp.counters(); // { queue: 2, process: 4 }
```
## simd
> simd([simd]) ⇒ <code>boolean</code>
Get and set use of SIMD vector unit instructions.
Requires libvips to have been compiled with highway support.
Improves the performance of `resize`, `blur` and `sharpen` operations
by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON.
| Param | Type | Default |
| --- | --- | --- |
| [simd] | <code>boolean</code> | <code>true</code> |
**Example**
```js
const simd = sharp.simd();
// simd is `true` if the runtime use of highway is currently enabled
```
**Example**
```js
const simd = sharp.simd(false);
// prevent libvips from using highway at runtime
```
## block
> block(options)
Block libvips operations at runtime.
This is in addition to the `VIPS_BLOCK_UNTRUSTED` environment variable,
which when set will block all "untrusted" operations.
**Since**: 0.32.4
| Param | Type | Description |
| --- | --- | --- |
| options | <code>Object</code> | |
| options.operation | <code>Array.<string></code> | List of libvips low-level operation names to block. |
**Example** *(Block all TIFF input.)*
```js
sharp.block({
operation: ['VipsForeignLoadTiff']
});
```
## unblock
> unblock(options)
Unblock libvips operations at runtime.
This is useful for defining a list of allowed operations.
**Since**: 0.32.4
| Param | Type | Description |
| --- | --- | --- |
| options | <code>Object</code> | |
| options.operation | <code>Array.<string></code> | List of libvips low-level operation names to unblock. |
**Example** *(Block all input except WebP from the filesystem.)*
```js
sharp.block({
operation: ['VipsForeignLoad']
});
sharp.unblock({
operation: ['VipsForeignLoadWebpFile']
});
```
**Example** *(Block all input except JPEG and PNG from a Buffer or Stream.)*
```js
sharp.block({
operation: ['VipsForeignLoad']
});
sharp.unblock({
operation: ['VipsForeignLoadJpegBuffer', 'VipsForeignLoadPngBuffer']
});
```
================================================
FILE: docs/src/content/docs/changelog/_meta.yml
================================================
sort: reverse-slug
================================================
FILE: docs/src/content/docs/changelog/v0.10.0.md
================================================
---
title: v0.10.0 - 23rd April 2015
slug: changelog/v0.10.0
---
* Add support for Windows (x86).
[#19](https://github.com/lovell/sharp/issues/19)
[@DullReferenceException](https://github.com/DullReferenceException)
[@itsananderson](https://github.com/itsananderson)
* Add support for Openslide input and DeepZoom output.
[#146](https://github.com/lovell/sharp/issues/146)
[@mvictoras](https://github.com/mvictoras)
* Allow arbitrary aspect ratios when resizing images via new `ignoreAspectRatio` method.
[#192](https://github.com/lovell/sharp/issues/192)
[@skedastik](https://github.com/skedastik)
* Enhance output image contrast by stretching its luminance to cover the full dynamic range via new `normalize` method.
[#194](https://github.com/lovell/sharp/issues/194)
[@bkw](https://github.com/bkw)
[@codingforce](https://github.com/codingforce)
================================================
FILE: docs/src/content/docs/changelog/v0.10.1.md
================================================
---
title: v0.10.1 - 1st June 2015
slug: changelog/v0.10.1
---
* Allow embed of image with alpha transparency onto non-transparent background.
[#204](https://github.com/lovell/sharp/issues/204)
[@mikemliu](https://github.com/mikemliu)
* Include C standard library for `atoi` as Xcode 6.3 appears to no longer do this.
[#228](https://github.com/lovell/sharp/issues/228)
[@doggan](https://github.com/doggan)
================================================
FILE: docs/src/content/docs/changelog/v0.11.0.md
================================================
---
title: v0.11.0 - 15th July 2015
slug: changelog/v0.11.0
---
* Allow alpha transparency compositing via new `overlayWith` method.
[#97](https://github.com/lovell/sharp/issues/97)
[@gasi](https://github.com/gasi)
* Expose raw ICC profile data as a Buffer when using `metadata`.
[#129](https://github.com/lovell/sharp/issues/129)
[@homerjam](https://github.com/homerjam)
* Allow image header updates via a parameter passed to existing `withMetadata` method.
Provide initial support for EXIF `Orientation` tag,
which if present is now removed when using `rotate`, `flip` or `flop`.
[#189](https://github.com/lovell/sharp/issues/189)
[@h2non](https://github.com/h2non)
* Tighten constructor parameter checks.
[#221](https://github.com/lovell/sharp/issues/221)
[@mikemorris](https://github.com/mikemorris)
* Allow one input Stream to be shared with two or more output Streams via new `clone` method.
[#235](https://github.com/lovell/sharp/issues/235)
[@jaubourg](https://github.com/jaubourg)
* Use `round` instead of `floor` when auto-scaling dimensions to avoid floating-point rounding errors.
[#238](https://github.com/lovell/sharp/issues/238)
[@richardadjogah](https://github.com/richardadjogah)
================================================
FILE: docs/src/content/docs/changelog/v0.11.1.md
================================================
---
title: v0.11.1 - 12th August 2015
slug: changelog/v0.11.1
---
* Silence MSVC warning: "C4530: C++ exception handler used, but unwind semantics are not enabled".
[#244](https://github.com/lovell/sharp/pull/244)
[@TheThing](https://github.com/TheThing)
* Suppress gamma correction for input image with alpha transparency.
[#249](https://github.com/lovell/sharp/issues/249)
[@compeak](https://github.com/compeak)
================================================
FILE: docs/src/content/docs/changelog/v0.11.2.md
================================================
---
title: v0.11.2 - 28th August 2015
slug: changelog/v0.11.2
---
* Allow crop gravity to be provided as a String.
[#255](https://github.com/lovell/sharp/pull/255)
[@papandreou](https://github.com/papandreou)
* Add support for io.js v3 and Node v4.
[#246](https://github.com/lovell/sharp/issues/246)
================================================
FILE: docs/src/content/docs/changelog/v0.11.3.md
================================================
---
title: v0.11.3 - 8th September 2015
slug: changelog/v0.11.3
---
* Intrepret blurSigma, sharpenFlat, and sharpenJagged as double precision.
[#263](https://github.com/lovell/sharp/pull/263)
[@chrisriley](https://github.com/chrisriley)
================================================
FILE: docs/src/content/docs/changelog/v0.11.4.md
================================================
---
title: v0.11.4 - 5th November 2015
slug: changelog/v0.11.4
---
* Add corners, e.g. `northeast`, to existing `gravity` option.
[#291](https://github.com/lovell/sharp/pull/291)
[@brandonaaron](https://github.com/brandonaaron)
* Ensure correct auto-rotation for EXIF Orientation values 2 and 4.
[#288](https://github.com/lovell/sharp/pull/288)
[@brandonaaron](https://github.com/brandonaaron)
* Make static linking possible via `--runtime_link` install option.
[#287](https://github.com/lovell/sharp/pull/287)
[@vlapo](https://github.com/vlapo)
================================================
FILE: docs/src/content/docs/changelog/v0.12.0.md
================================================
---
title: v0.12.0 - 23rd November 2015
slug: changelog/v0.12.0
---
* Bundle pre-compiled libvips and its dependencies for 64-bit Linux and Windows.
[#42](https://github.com/lovell/sharp/issues/42)
* Take advantage of libvips v8.1.0+ features.
[#152](https://github.com/lovell/sharp/issues/152)
* Add support for 64-bit Windows. Drop support for 32-bit Windows.
[#224](https://github.com/lovell/sharp/issues/224)
[@sabrehagen](https://github.com/sabrehagen)
* Switch default interpolator to bicubic.
[#289](https://github.com/lovell/sharp/issues/289)
[@mahnunchik](https://github.com/mahnunchik)
* Pre-extract rotatation should not swap width/height.
[#296](https://github.com/lovell/sharp/issues/296)
[@asilvas](https://github.com/asilvas)
* Ensure 16-bit+alpha input images are (un)premultiplied correctly.
[#301](https://github.com/lovell/sharp/issues/301)
[@izaakschroeder](https://github.com/izaakschroeder)
* Add `threshold` operation.
[#303](https://github.com/lovell/sharp/pull/303)
[@dacarley](https://github.com/dacarley)
* Add `negate` operation.
[#306](https://github.com/lovell/sharp/pull/306)
[@dacarley](https://github.com/dacarley)
* Support `options` Object with existing `extract` operation.
[#309](https://github.com/lovell/sharp/pull/309)
[@papandreou](https://github.com/papandreou)
================================================
FILE: docs/src/content/docs/changelog/v0.12.1.md
================================================
---
title: v0.12.1 - 12th December 2015
slug: changelog/v0.12.1
---
* Allow use of SIMD vector instructions (via liborc) to be toggled on/off.
[#172](https://github.com/lovell/sharp/issues/172)
[@bkw](https://github.com/bkw)
[@puzrin](https://github.com/puzrin)
* Ensure embedded ICC profiles output with perceptual intent.
[#321](https://github.com/lovell/sharp/issues/321)
[@vlapo](https://github.com/vlapo)
* Use the NPM-configured HTTPS proxy, if any, for binary downloads.
================================================
FILE: docs/src/content/docs/changelog/v0.12.2.md
================================================
---
title: v0.12.2 - 16th January 2016
slug: changelog/v0.12.2
---
* Upgrade libvips to v8.2.0 for improved vips_shrink.
* Add pre-compiled libvips for ARMv6+ CPUs.
* Ensure 16-bit input images work with embed option.
[#325](https://github.com/lovell/sharp/issues/325)
[@janaz](https://github.com/janaz)
* Allow compilation with gmake to provide FreeBSD support.
[#326](https://github.com/lovell/sharp/issues/326)
[@c0decafe](https://github.com/c0decafe)
* Attempt to remove temporary file after installation.
[#331](https://github.com/lovell/sharp/issues/331)
[@dtoubelis](https://github.com/dtoubelis)
================================================
FILE: docs/src/content/docs/changelog/v0.13.0.md
================================================
---
title: v0.13.0 - 15th February 2016
slug: changelog/v0.13.0
---
* Improve vector image support by allowing control of density/DPI.
Switch pre-built libs from Imagemagick to Graphicsmagick.
[#110](https://github.com/lovell/sharp/issues/110)
[@bradisbell](https://github.com/bradisbell)
* Add support for raw, uncompressed pixel Buffer/Stream input.
[#220](https://github.com/lovell/sharp/issues/220)
[@mikemorris](https://github.com/mikemorris)
* Switch from libvips' C to C++ bindings, requires upgrade to v8.2.2.
[#299](https://github.com/lovell/sharp/issues/299)
* Control number of open files in libvips' cache; breaks existing `cache` behaviour.
[#315](https://github.com/lovell/sharp/issues/315)
[@impomezia](https://github.com/impomezia)
* Ensure 16-bit input images can be normalised and embedded onto transparent backgrounds.
[#339](https://github.com/lovell/sharp/issues/339)
[#340](https://github.com/lovell/sharp/issues/340)
[@janaz](https://github.com/janaz)
* Ensure selected format takes precedence over any unknown output filename extension.
[#344](https://github.com/lovell/sharp/issues/344)
[@ubaltaci](https://github.com/ubaltaci)
* Add support for libvips' PBM, PGM, PPM and FITS image format loaders.
[#347](https://github.com/lovell/sharp/issues/347)
[@oaleynik](https://github.com/oaleynik)
* Ensure default crop gravity is center/centre.
[#351](https://github.com/lovell/sharp/pull/351)
[@joelmukuthu](https://github.com/joelmukuthu)
* Improve support for musl libc systems e.g. Alpine Linux.
[#354](https://github.com/lovell/sharp/issues/354)
[#359](https://github.com/lovell/sharp/pull/359)
[@download13](https://github.com/download13)
[@wjordan](https://github.com/wjordan)
* Small optimisation when reducing by an integral factor to favour shrink over affine.
* Add support for gamma correction of images with an alpha channel.
================================================
FILE: docs/src/content/docs/changelog/v0.13.1.md
================================================
---
title: v0.13.1 - 27th February 2016
slug: changelog/v0.13.1
---
* Fix embedding onto transparent backgrounds; regression introduced in v0.13.0.
[#366](https://github.com/lovell/sharp/issues/366)
[@diegocsandrim](https://github.com/diegocsandrim)
================================================
FILE: docs/src/content/docs/changelog/v0.14.0.md
================================================
---
title: v0.14.0 - 2nd April 2016
slug: changelog/v0.14.0
---
* Add ability to extend (pad) the edges of an image.
[#128](https://github.com/lovell/sharp/issues/128)
[@blowsie](https://github.com/blowsie)
* Add support for Zoomify and Google tile layouts. Breaks existing tile API.
[#223](https://github.com/lovell/sharp/issues/223)
[@bdunnette](https://github.com/bdunnette)
* Improvements to overlayWith: differing sizes/formats, gravity, buffer input.
[#239](https://github.com/lovell/sharp/issues/239)
[@chrisriley](https://github.com/chrisriley)
* Add entropy-based crop strategy to remove least interesting edges.
[#295](https://github.com/lovell/sharp/issues/295)
[@rightaway](https://github.com/rightaway)
* Expose density metadata; set density of images from vector input.
[#338](https://github.com/lovell/sharp/issues/338)
[@lookfirst](https://github.com/lookfirst)
* Emit post-processing 'info' event for Stream output.
[#367](https://github.com/lovell/sharp/issues/367)
[@salzhrani](https://github.com/salzhrani)
* Ensure output image EXIF Orientation values are within 1-8 range.
[#385](https://github.com/lovell/sharp/pull/385)
[@jtobinisaniceguy](https://github.com/jtobinisaniceguy)
* Ensure ratios are not swapped when rotating 90/270 and ignoring aspect.
[#387](https://github.com/lovell/sharp/issues/387)
[@kleisauke](https://github.com/kleisauke)
* Remove deprecated style of calling extract API. Breaks calls using positional arguments.
[#276](https://github.com/lovell/sharp/issues/276)
================================================
FILE: docs/src/content/docs/changelog/v0.14.1.md
================================================
---
title: v0.14.1 - 16th April 2016
slug: changelog/v0.14.1
---
* Allow removal of limitation on input pixel count via limitInputPixels. Use with care.
[#250](https://github.com/lovell/sharp/issues/250)
[#316](https://github.com/lovell/sharp/pull/316)
[@anandthakker](https://github.com/anandthakker)
[@kentongray](https://github.com/kentongray)
* Use final output image for metadata passed to callback.
[#399](https://github.com/lovell/sharp/pull/399)
[@salzhrani](https://github.com/salzhrani)
* Add support for writing tiled images to a zip container.
[#402](https://github.com/lovell/sharp/pull/402)
[@felixbuenemann](https://github.com/felixbuenemann)
* Allow use of embed with 1 and 2 channel images.
[#411](https://github.com/lovell/sharp/issues/411)
[@janaz](https://github.com/janaz)
* Improve Electron compatibility by allowing node-gyp rebuilds without npm.
[#412](https://github.com/lovell/sharp/issues/412)
[@nouh](https://github.com/nouh)
================================================
FILE: docs/src/content/docs/changelog/v0.15.0.md
================================================
---
title: v0.15.0 - 21st May 2016
slug: changelog/v0.15.0
---
* Use libvips' new Lanczos 3 kernel as default for image reduction.
Deprecate interpolateWith method, now provided as a resize option.
[#310](https://github.com/lovell/sharp/issues/310)
[@jcupitt](https://github.com/jcupitt)
* Take advantage of libvips v8.3 features.
Add support for libvips' new GIF and SVG loaders.
Pre-built binaries now include giflib and librsvg, exclude *magick.
Use shrink-on-load for WebP input.
Break existing sharpen API to accept sigma and improve precision.
[#369](https://github.com/lovell/sharp/issues/369)
* Remove unnecessary (un)premultiply operations when not resizing/compositing.
[#413](https://github.com/lovell/sharp/issues/413)
[@jardakotesovec](https://github.com/jardakotesovec)
================================================
FILE: docs/src/content/docs/changelog/v0.15.1.md
================================================
---
title: v0.15.1 - 12th July 2016
slug: changelog/v0.15.1
---
* Concat Stream-based input in single operation for ~+3% perf and less GC.
[#429](https://github.com/lovell/sharp/issues/429)
[@papandreou](https://github.com/papandreou)
* Add alpha channel, if required, before extend operation.
[#439](https://github.com/lovell/sharp/pull/439)
[@frulo](https://github.com/frulo)
* Allow overlay image to be repeated across entire image via tile option.
[#443](https://github.com/lovell/sharp/pull/443)
[@lemnisk8](https://github.com/lemnisk8)
* Add cutout option to overlayWith feature, applies only the alpha channel of the overlay image.
[#448](https://github.com/lovell/sharp/pull/448)
[@kleisauke](https://github.com/kleisauke)
* Ensure scaling factors are calculated independently to prevent rounding errors.
[#452](https://github.com/lovell/sharp/issues/452)
[@puzrin](https://github.com/puzrin)
* Add --sharp-cxx11 flag to compile with gcc's new C++11 ABI.
[#456](https://github.com/lovell/sharp/pull/456)
[@kapouer](https://github.com/kapouer)
* Add top/left offset support to overlayWith operation.
[#473](https://github.com/lovell/sharp/pull/473)
[@rnanwani](https://github.com/rnanwani)
* Add convolve operation for kernel-based convolution.
[#479](https://github.com/lovell/sharp/pull/479)
[@mhirsch](https://github.com/mhirsch)
* Add greyscale option to threshold operation for colourspace conversion control.
[#480](https://github.com/lovell/sharp/pull/480)
[@mhirsch](https://github.com/mhirsch)
* Ensure ICC profiles are licenced for distribution.
[#486](https://github.com/lovell/sharp/issues/486)
[@kapouer](https://github.com/kapouer)
* Allow images with an alpha channel to work with LAB-colourspace based sharpen.
[#490](https://github.com/lovell/sharp/issues/490)
[@jwagner](https://github.com/jwagner)
* Add trim operation to remove "boring" edges.
[#492](https://github.com/lovell/sharp/pull/492)
[@kleisauke](https://github.com/kleisauke)
* Add bandbool feature for channel-wise boolean operations.
[#496](https://github.com/lovell/sharp/pull/496)
[@mhirsch](https://github.com/mhirsch)
* Add extractChannel operation to extract a channel from an image.
[#497](https://github.com/lovell/sharp/pull/497)
[@mhirsch](https://github.com/mhirsch)
* Add ability to read and write native libvips .v files.
[#500](https://github.com/lovell/sharp/pull/500)
[@mhirsch](https://github.com/mhirsch)
* Add boolean feature for bitwise image operations.
[#501](https://github.com/lovell/sharp/pull/501)
[@mhirsch](https://github.com/mhirsch)
================================================
FILE: docs/src/content/docs/changelog/v0.16.0.md
================================================
---
title: v0.16.0 - 18th August 2016
slug: changelog/v0.16.0
---
* Add pre-compiled libvips for OS X, ARMv7 and ARMv8.
[#312](https://github.com/lovell/sharp/issues/312)
* Ensure boolean, bandbool, extractChannel ops occur before sRGB conversion.
[#504](https://github.com/lovell/sharp/pull/504)
[@mhirsch](https://github.com/mhirsch)
* Recalculate factors after WebP shrink-on-load to avoid round-to-zero errors.
[#508](https://github.com/lovell/sharp/issues/508)
[@asilvas](https://github.com/asilvas)
* Prevent boolean errors during extract operation.
[#511](https://github.com/lovell/sharp/pull/511)
[@mhirsch](https://github.com/mhirsch)
* Add joinChannel and toColourspace/toColorspace operations.
[#513](https://github.com/lovell/sharp/pull/513)
[@mhirsch](https://github.com/mhirsch)
* Add support for raw pixel data with boolean and withOverlay operations.
[#516](https://github.com/lovell/sharp/pull/516)
[@mhirsch](https://github.com/mhirsch)
* Prevent bandbool creating a single channel sRGB image.
[#519](https://github.com/lovell/sharp/pull/519)
[@mhirsch](https://github.com/mhirsch)
* Ensure ICC profiles are removed from PNG output unless withMetadata used.
[#521](https://github.com/lovell/sharp/issues/521)
[@ChrisPinewood](https://github.com/ChrisPinewood)
* Add alpha channels, if missing, to overlayWith images.
[#540](https://github.com/lovell/sharp/pull/540)
[@cmtt](https://github.com/cmtt)
* Remove deprecated interpolateWith method - use resize(w, h, { interpolator: ... })
[#310](https://github.com/lovell/sharp/issues/310)
================================================
FILE: docs/src/content/docs/changelog/v0.16.1.md
================================================
---
title: v0.16.1 - 13th October 2016
slug: changelog/v0.16.1
---
* C++11 ABI version is now auto-detected, remove sharp-cxx11 installation flag.
* Add experimental 'attention' crop strategy.
[#295](https://github.com/lovell/sharp/issues/295)
* Include .node extension for Meteor's require() implementation.
[#537](https://github.com/lovell/sharp/issues/537)
[@isjackwild](https://github.com/isjackwild)
* Ensure convolution kernel scale is clamped to a minimum value of 1.
[#561](https://github.com/lovell/sharp/issues/561)
[@abagshaw](https://github.com/abagshaw)
* Correct calculation of y-axis placement when overlaying image at a fixed point.
[#566](https://github.com/lovell/sharp/issues/566)
[@Nateowami](https://github.com/Nateowami)
================================================
FILE: docs/src/content/docs/changelog/v0.16.2.md
================================================
---
title: v0.16.2 - 22nd October 2016
slug: changelog/v0.16.2
---
* Restrict readelf usage to Linux only when detecting global libvips version.
[#602](https://github.com/lovell/sharp/issues/602)
[@caoko](https://github.com/caoko)
================================================
FILE: docs/src/content/docs/changelog/v0.17.0.md
================================================
---
title: v0.17.0 - 11th December 2016
slug: changelog/v0.17.0
---
* Drop support for versions of Node prior to v4.
* Deprecate the following output format "option" functions:
quality, progressive, compressionLevel, withoutAdaptiveFiltering,
withoutChromaSubsampling, trellisQuantisation, trellisQuantization,
overshootDeringing, optimiseScans and optimizeScans.
Access to these is now via output format functions, for example `quality(n)`
is now `jpeg({quality: n})` and/or `webp({quality: n})`.
* Autoconvert GIF and SVG input to PNG output if no other format is specified.
* Expose libvips' "centre" resize option to mimic \*magick's +0.5px convention.
[#568](https://github.com/lovell/sharp/issues/568)
* Ensure support for embedded base64 PNG and JPEG images within an SVG.
[#601](https://github.com/lovell/sharp/issues/601)
[@dynamite-ready](https://github.com/dynamite-ready)
* Ensure premultiply operation occurs before box filter shrink.
[#605](https://github.com/lovell/sharp/issues/605)
[@CmdrShepardsPie](https://github.com/CmdrShepardsPie)
[@teroparvinen](https://github.com/teroparvinen)
* Add support for PNG and WebP tile-based output formats (in addition to JPEG).
[#622](https://github.com/lovell/sharp/pull/622)
[@ppaskaris](https://github.com/ppaskaris)
* Allow use of extend with greyscale input.
[#623](https://github.com/lovell/sharp/pull/623)
[@ppaskaris](https://github.com/ppaskaris)
* Allow non-RGB input to embed/extend onto background with an alpha channel.
[#646](https://github.com/lovell/sharp/issues/646)
[@DaGaMs](https://github.com/DaGaMs)
================================================
FILE: docs/src/content/docs/changelog/v0.17.1.md
================================================
---
title: v0.17.1 - 15th January 2017
slug: changelog/v0.17.1
---
* Improve error messages for invalid parameters.
[@spikeon](https://github.com/spikeon)
[#644](https://github.com/lovell/sharp/pull/644)
* Simplify expression for finding vips-cpp libdir.
[#656](https://github.com/lovell/sharp/pull/656)
* Allow HTTPS-over-HTTP proxy when downloading pre-compiled dependencies.
[@wangzhiwei1888](https://github.com/wangzhiwei1888)
[#679](https://github.com/lovell/sharp/issues/679)
================================================
FILE: docs/src/content/docs/changelog/v0.17.2.md
================================================
---
title: v0.17.2 - 11th February 2017
slug: changelog/v0.17.2
---
* Ensure Readable side of Stream can start flowing after Writable side has finished.
[#671](https://github.com/lovell/sharp/issues/671)
[@danhaller](https://github.com/danhaller)
* Expose WebP alpha quality, lossless and near-lossless output options.
[#685](https://github.com/lovell/sharp/pull/685)
[@rnanwani](https://github.com/rnanwani)
================================================
FILE: docs/src/content/docs/changelog/v0.17.3.md
================================================
---
title: v0.17.3 - 1st April 2017
slug: changelog/v0.17.3
---
* Allow toBuffer to optionally resolve a Promise with both info and data.
[#143](https://github.com/lovell/sharp/issues/143)
[@salzhrani](https://github.com/salzhrani)
* Create blank image of given width, height, channels and background.
[#470](https://github.com/lovell/sharp/issues/470)
[@pjarts](https://github.com/pjarts)
* Add support for the "nearest" kernel for image reductions.
[#732](https://github.com/lovell/sharp/pull/732)
[@alice0meta](https://github.com/alice0meta)
* Add support for TIFF compression and predictor options.
[#738](https://github.com/lovell/sharp/pull/738)
[@kristojorg](https://github.com/kristojorg)
================================================
FILE: docs/src/content/docs/changelog/v0.18.0.md
================================================
---
title: v0.18.0 - 30th May 2017
slug: changelog/v0.18.0
---
* Remove the previously-deprecated output format "option" functions:
quality, progressive, compressionLevel, withoutAdaptiveFiltering,
withoutChromaSubsampling, trellisQuantisation, trellisQuantization,
overshootDeringing, optimiseScans and optimizeScans.
* Ensure maximum output dimensions are based on the format to be used.
[#176](https://github.com/lovell/sharp/issues/176)
[@stephanebachelier](https://github.com/stephanebachelier)
* Avoid costly (un)premultiply when using overlayWith without alpha channel.
[#573](https://github.com/lovell/sharp/issues/573)
[@strarsis](https://github.com/strarsis)
* Include pixel depth (e.g. "uchar") when reading metadata.
[#577](https://github.com/lovell/sharp/issues/577)
[@moedusa](https://github.com/moedusa)
* Add support for Buffer and Stream-based TIFF output.
[#587](https://github.com/lovell/sharp/issues/587)
[@strarsis](https://github.com/strarsis)
* Expose warnings from libvips via NODE_DEBUG=sharp environment variable.
[#607](https://github.com/lovell/sharp/issues/607)
[@puzrin](https://github.com/puzrin)
* Switch to the libvips implementation of "attention" and "entropy" crop strategies.
[#727](https://github.com/lovell/sharp/issues/727)
* Improve performance and accuracy of nearest neighbour integral upsampling.
[#752](https://github.com/lovell/sharp/issues/752)
[@MrIbby](https://github.com/MrIbby)
* Constructor single argument API: allow plain object, reject null/undefined.
[#768](https://github.com/lovell/sharp/issues/768)
[@kub1x](https://github.com/kub1x)
* Ensure ARM64 pre-built binaries use correct C++11 ABI version.
[#772](https://github.com/lovell/sharp/issues/772)
[@ajiratech2](https://github.com/ajiratech2)
* Prevent aliasing by using dynamic values for shrink(-on-load).
[#781](https://github.com/lovell/sharp/issues/781)
[@kleisauke](https://github.com/kleisauke)
* Expose libvips' "squash" parameter to enable 1-bit TIFF output.
[#783](https://github.com/lovell/sharp/pull/783)
[@YvesBos](https://github.com/YvesBos)
* Add support for rotation using any multiple of +/-90 degrees.
[#791](https://github.com/lovell/sharp/pull/791)
[@ncoden](https://github.com/ncoden)
* Add "jpg" alias to toFormat as shortened form of "jpeg".
[#814](https://github.com/lovell/sharp/pull/814)
[@jingsam](https://github.com/jingsam)
================================================
FILE: docs/src/content/docs/changelog/v0.18.1.md
================================================
---
title: v0.18.1 - 30th May 2017
slug: changelog/v0.18.1
---
* Remove regression from #781 that could cause incorrect shrink calculation.
[#831](https://github.com/lovell/sharp/issues/831)
[@suprMax](https://github.com/suprMax)
================================================
FILE: docs/src/content/docs/changelog/v0.18.2.md
================================================
---
title: v0.18.2 - 1st July 2017
slug: changelog/v0.18.2
---
* Expose libvips' xres and yres properties for TIFF output.
[#828](https://github.com/lovell/sharp/pull/828)
[@YvesBos](https://github.com/YvesBos)
* Ensure flip and flop operations work with auto-rotate.
[#837](https://github.com/lovell/sharp/issues/837)
[@rexxars](https://github.com/rexxars)
* Allow binary download URL override via SHARP_DIST_BASE_URL env variable.
[#841](https://github.com/lovell/sharp/issues/841)
* Add support for Solus Linux.
[#857](https://github.com/lovell/sharp/pull/857)
[@ekremkaraca](https://github.com/ekremkaraca)
================================================
FILE: docs/src/content/docs/changelog/v0.18.3.md
================================================
---
title: v0.18.3 - 13th September 2017
slug: changelog/v0.18.3
---
* Skip shrink-on-load when trimming.
[#888](https://github.com/lovell/sharp/pull/888)
[@kleisauke](https://github.com/kleisauke)
* Migrate from got to simple-get for basic auth support.
[#945](https://github.com/lovell/sharp/pull/945)
[@pbomb](https://github.com/pbomb)
================================================
FILE: docs/src/content/docs/changelog/v0.18.4.md
================================================
---
title: v0.18.4 - 18th September 2017
slug: changelog/v0.18.4
---
* Ensure input Buffer really is marked as Persistent, prevents mark-sweep GC.
[#950](https://github.com/lovell/sharp/issues/950)
[@lfdoherty](https://github.com/lfdoherty)
================================================
FILE: docs/src/content/docs/changelog/v0.19.0.md
================================================
---
title: v0.19.0 - 11th January 2018
slug: changelog/v0.19.0
---
* Expose offset coordinates of strategy-based crop.
[#868](https://github.com/lovell/sharp/issues/868)
[@mirohristov-com](https://github.com/mirohristov-com)
* PNG output now defaults to adaptiveFiltering=false, compressionLevel=9
[#872](https://github.com/lovell/sharp/issues/872)
[@wmertens](https://github.com/wmertens)
* Add stats feature for pixel-derived image statistics.
[#915](https://github.com/lovell/sharp/pull/915)
[@rnanwani](https://github.com/rnanwani)
* Add failOnError option to fail-fast on bad input image data.
[#976](https://github.com/lovell/sharp/pull/976)
[@mceachen](https://github.com/mceachen)
* Resize: switch to libvips' implementation, make fastShrinkOnLoad optional, remove interpolator and centreSampling options.
[#977](https://github.com/lovell/sharp/pull/977)
[@jardakotesovec](https://github.com/jardakotesovec)
* Attach finish event listener to a clone only for Stream-based input.
[#995](https://github.com/lovell/sharp/issues/995)
[@whmountains](https://github.com/whmountains)
* Add tilecache before smartcrop to avoid over-computation of previous operations.
[#1028](https://github.com/lovell/sharp/issues/1028)
[@coffeebite](https://github.com/coffeebite)
* Prevent toFile extension taking precedence over requested format.
[#1037](https://github.com/lovell/sharp/issues/1037)
[@tomgallagher](https://github.com/tomgallagher)
* Add support for gravity option to existing embed feature.
[#1038](https://github.com/lovell/sharp/pull/1038)
[@AzureByte](https://github.com/AzureByte)
* Expose IPTC and XMP metadata when available.
[#1079](https://github.com/lovell/sharp/pull/1079)
[@oaleynik](https://github.com/oaleynik)
* TIFF output: switch default predictor from 'none' to 'horizontal' to match libvips' behaviour.
================================================
FILE: docs/src/content/docs/changelog/v0.19.1.md
================================================
---
title: v0.19.1 - 24th February 2018
slug: changelog/v0.19.1
---
* Expose libvips' linear transform feature.
[#1024](https://github.com/lovell/sharp/pull/1024)
[@3epnm](https://github.com/3epnm)
* Expose angle option for tile-based output.
[#1121](https://github.com/lovell/sharp/pull/1121)
[@BiancoA](https://github.com/BiancoA)
* Prevent crop operation when image already at or below target dimensions.
[#1134](https://github.com/lovell/sharp/issues/1134)
[@pieh](https://github.com/pieh)
================================================
FILE: docs/src/content/docs/changelog/v0.20.0.md
================================================
---
title: v0.20.0 - 5th March 2018
slug: changelog/v0.20.0
---
* Add support for prebuilt sharp binaries on common platforms.
[#186](https://github.com/lovell/sharp/issues/186)
================================================
FILE: docs/src/content/docs/changelog/v0.20.1.md
================================================
---
title: v0.20.1 - 17th March 2018
slug: changelog/v0.20.1
---
* Improve installation experience when a globally-installed libvips below the minimum required version is found.
[#1148](https://github.com/lovell/sharp/issues/1148)
* Prevent smartcrop error when cumulative rounding is below target size.
[#1154](https://github.com/lovell/sharp/issues/1154)
[@ralrom](https://github.com/ralrom)
* Expose libvips' median filter operation.
[#1161](https://github.com/lovell/sharp/pull/1161)
[@BiancoA](https://github.com/BiancoA)
================================================
FILE: docs/src/content/docs/changelog/v0.20.2.md
================================================
---
title: v0.20.2 - 28th April 2018
slug: changelog/v0.20.2
---
* Add tint operation to set image chroma.
[#825](https://github.com/lovell/sharp/pull/825)
[@rikh42](https://github.com/rikh42)
* Add environment variable to ignore globally-installed libvips.
[#1165](https://github.com/lovell/sharp/pull/1165)
[@oncletom](https://github.com/oncletom)
* Add support for page selection with multi-page input (GIF/TIFF).
[#1204](https://github.com/lovell/sharp/pull/1204)
[@woolite64](https://github.com/woolite64)
* Add support for Group4 (CCITTFAX4) compression with TIFF output.
[#1208](https://github.com/lovell/sharp/pull/1208)
[@woolite64](https://github.com/woolite64)
================================================
FILE: docs/src/c
gitextract_pusvgzt3/
├── .cirrus.yml
├── .editorconfig
├── .github/
│ ├── CONTRIBUTING.md
│ ├── FUNDING.yml
│ ├── ISSUE_TEMPLATE/
│ │ ├── config.yml
│ │ ├── feature_request.md
│ │ ├── installation.md
│ │ ├── possible-bug.md
│ │ └── question.md
│ ├── SECURITY.md
│ └── workflows/
│ ├── ci.yml
│ └── npm.yml
├── .gitignore
├── LICENSE
├── README.md
├── biome.json
├── docs/
│ ├── astro.config.mjs
│ ├── build.mjs
│ ├── firebase.json
│ ├── package.json
│ ├── public/
│ │ ├── humans.txt
│ │ └── robots.txt
│ ├── src/
│ │ ├── content/
│ │ │ └── docs/
│ │ │ ├── api-channel.md
│ │ │ ├── api-colour.md
│ │ │ ├── api-composite.md
│ │ │ ├── api-constructor.md
│ │ │ ├── api-input.md
│ │ │ ├── api-operation.md
│ │ │ ├── api-output.md
│ │ │ ├── api-resize.md
│ │ │ ├── api-utility.md
│ │ │ ├── changelog/
│ │ │ │ ├── _meta.yml
│ │ │ │ ├── v0.10.0.md
│ │ │ │ ├── v0.10.1.md
│ │ │ │ ├── v0.11.0.md
│ │ │ │ ├── v0.11.1.md
│ │ │ │ ├── v0.11.2.md
│ │ │ │ ├── v0.11.3.md
│ │ │ │ ├── v0.11.4.md
│ │ │ │ ├── v0.12.0.md
│ │ │ │ ├── v0.12.1.md
│ │ │ │ ├── v0.12.2.md
│ │ │ │ ├── v0.13.0.md
│ │ │ │ ├── v0.13.1.md
│ │ │ │ ├── v0.14.0.md
│ │ │ │ ├── v0.14.1.md
│ │ │ │ ├── v0.15.0.md
│ │ │ │ ├── v0.15.1.md
│ │ │ │ ├── v0.16.0.md
│ │ │ │ ├── v0.16.1.md
│ │ │ │ ├── v0.16.2.md
│ │ │ │ ├── v0.17.0.md
│ │ │ │ ├── v0.17.1.md
│ │ │ │ ├── v0.17.2.md
│ │ │ │ ├── v0.17.3.md
│ │ │ │ ├── v0.18.0.md
│ │ │ │ ├── v0.18.1.md
│ │ │ │ ├── v0.18.2.md
│ │ │ │ ├── v0.18.3.md
│ │ │ │ ├── v0.18.4.md
│ │ │ │ ├── v0.19.0.md
│ │ │ │ ├── v0.19.1.md
│ │ │ │ ├── v0.20.0.md
│ │ │ │ ├── v0.20.1.md
│ │ │ │ ├── v0.20.2.md
│ │ │ │ ├── v0.20.3.md
│ │ │ │ ├── v0.20.4.md
│ │ │ │ ├── v0.20.5.md
│ │ │ │ ├── v0.20.6.md
│ │ │ │ ├── v0.20.7.md
│ │ │ │ ├── v0.20.8.md
│ │ │ │ ├── v0.21.0.md
│ │ │ │ ├── v0.21.1.md
│ │ │ │ ├── v0.21.2.md
│ │ │ │ ├── v0.21.3.md
│ │ │ │ ├── v0.22.0.md
│ │ │ │ ├── v0.22.1.md
│ │ │ │ ├── v0.23.0.md
│ │ │ │ ├── v0.23.1.md
│ │ │ │ ├── v0.23.2.md
│ │ │ │ ├── v0.23.3.md
│ │ │ │ ├── v0.23.4.md
│ │ │ │ ├── v0.24.0.md
│ │ │ │ ├── v0.24.1.md
│ │ │ │ ├── v0.25.0.md
│ │ │ │ ├── v0.25.1.md
│ │ │ │ ├── v0.25.2.md
│ │ │ │ ├── v0.25.3.md
│ │ │ │ ├── v0.25.4.md
│ │ │ │ ├── v0.26.0.md
│ │ │ │ ├── v0.26.1.md
│ │ │ │ ├── v0.26.2.md
│ │ │ │ ├── v0.26.3.md
│ │ │ │ ├── v0.27.0.md
│ │ │ │ ├── v0.27.1.md
│ │ │ │ ├── v0.27.2.md
│ │ │ │ ├── v0.28.0.md
│ │ │ │ ├── v0.28.1.md
│ │ │ │ ├── v0.28.2.md
│ │ │ │ ├── v0.28.3.md
│ │ │ │ ├── v0.29.0.md
│ │ │ │ ├── v0.29.1.md
│ │ │ │ ├── v0.29.2.md
│ │ │ │ ├── v0.29.3.md
│ │ │ │ ├── v0.30.0.md
│ │ │ │ ├── v0.30.1.md
│ │ │ │ ├── v0.30.2.md
│ │ │ │ ├── v0.30.3.md
│ │ │ │ ├── v0.30.4.md
│ │ │ │ ├── v0.30.5.md
│ │ │ │ ├── v0.30.6.md
│ │ │ │ ├── v0.30.7.md
│ │ │ │ ├── v0.31.0.md
│ │ │ │ ├── v0.31.1.md
│ │ │ │ ├── v0.31.2.md
│ │ │ │ ├── v0.31.3.md
│ │ │ │ ├── v0.32.0.md
│ │ │ │ ├── v0.32.1.md
│ │ │ │ ├── v0.32.2.md
│ │ │ │ ├── v0.32.3.md
│ │ │ │ ├── v0.32.4.md
│ │ │ │ ├── v0.32.5.md
│ │ │ │ ├── v0.32.6.md
│ │ │ │ ├── v0.33.0.md
│ │ │ │ ├── v0.33.1.md
│ │ │ │ ├── v0.33.2.md
│ │ │ │ ├── v0.33.3.md
│ │ │ │ ├── v0.33.4.md
│ │ │ │ ├── v0.33.5.md
│ │ │ │ ├── v0.34.0.md
│ │ │ │ ├── v0.34.1.md
│ │ │ │ ├── v0.34.2.md
│ │ │ │ ├── v0.34.3.md
│ │ │ │ ├── v0.34.4.md
│ │ │ │ └── v0.34.5.md
│ │ │ ├── index.md
│ │ │ ├── install.md
│ │ │ └── performance.md
│ │ ├── content.config.ts
│ │ └── styles/
│ │ └── custom.css
│ └── tsconfig.json
├── install/
│ ├── build.js
│ └── check.js
├── lib/
│ ├── channel.js
│ ├── colour.js
│ ├── composite.js
│ ├── constructor.js
│ ├── index.d.ts
│ ├── index.js
│ ├── input.js
│ ├── is.js
│ ├── libvips.js
│ ├── operation.js
│ ├── output.js
│ ├── resize.js
│ ├── sharp.js
│ └── utility.js
├── npm/
│ ├── darwin-arm64/
│ │ └── package.json
│ ├── darwin-x64/
│ │ └── package.json
│ ├── from-local-build.js
│ ├── linux-arm/
│ │ └── package.json
│ ├── linux-arm64/
│ │ └── package.json
│ ├── linux-ppc64/
│ │ └── package.json
│ ├── linux-riscv64/
│ │ └── package.json
│ ├── linux-s390x/
│ │ └── package.json
│ ├── linux-x64/
│ │ └── package.json
│ ├── linuxmusl-arm64/
│ │ └── package.json
│ ├── linuxmusl-x64/
│ │ └── package.json
│ ├── package.json
│ ├── release-notes.js
│ ├── wasm32/
│ │ └── package.json
│ ├── win32-arm64/
│ │ └── package.json
│ ├── win32-ia32/
│ │ └── package.json
│ └── win32-x64/
│ └── package.json
├── package.json
├── src/
│ ├── CPPLINT.cfg
│ ├── binding.gyp
│ ├── common.cc
│ ├── common.h
│ ├── emscripten/
│ │ ├── common.gypi
│ │ └── pre.js
│ ├── metadata.cc
│ ├── metadata.h
│ ├── operations.cc
│ ├── operations.h
│ ├── pipeline.cc
│ ├── pipeline.h
│ ├── sharp.cc
│ ├── stats.cc
│ ├── stats.h
│ ├── utilities.cc
│ └── utilities.h
└── test/
├── bench/
│ ├── Dockerfile
│ ├── package.json
│ ├── parallel.js
│ ├── perf.js
│ ├── random.js
│ └── run-with-docker.sh
├── fixtures/
│ ├── 8bit_depth.tiff
│ ├── G31D.TIF
│ ├── G31D_MULTI.TIF
│ ├── XCMYK 2017.icc
│ ├── bonne.geo.tif
│ ├── cielab-dagams.tiff
│ ├── expected/
│ │ ├── colourspace.cmyk-to-cmyk-negated.tif
│ │ └── extract.tiff
│ ├── fogra-0-100-100-0.tif
│ ├── hilutite.icm
│ ├── index.js
│ ├── invalid-illuminant.icc
│ ├── relax.jp2
│ ├── relax_tileparts.jp2
│ ├── sdr_cosmos12920_cicp1-13-6_yuv444_full_qp10.avif
│ ├── tifftag-photoshop.tiff
│ ├── uncompressed_tiff.tiff
│ └── vfile.v
├── leak/
│ ├── leak.sh
│ └── sharp.supp
├── types/
│ ├── sharp.test-d.ts
│ └── tsconfig.json
├── unit/
│ ├── affine.js
│ ├── alpha.js
│ ├── avif.js
│ ├── bandbool.js
│ ├── blur.js
│ ├── boolean.js
│ ├── clahe.js
│ ├── clone.js
│ ├── colourspace.js
│ ├── composite.js
│ ├── convolve.js
│ ├── dilate.js
│ ├── erode.js
│ ├── extend.js
│ ├── extract.js
│ ├── extractChannel.js
│ ├── failOn.js
│ ├── fixtures.js
│ ├── gamma.js
│ ├── gif.js
│ ├── heif.js
│ ├── io.js
│ ├── join.js
│ ├── joinChannel.js
│ ├── jp2.js
│ ├── jpeg.js
│ ├── jxl.js
│ ├── libvips.js
│ ├── linear.js
│ ├── median.js
│ ├── metadata.js
│ ├── modulate.js
│ ├── negate.js
│ ├── noise.js
│ ├── normalize.js
│ ├── png.js
│ ├── raw.js
│ ├── recomb.js
│ ├── resize-contain.js
│ ├── resize-cover.js
│ ├── resize.js
│ ├── rotate.js
│ ├── sharpen.js
│ ├── stats.js
│ ├── svg.js
│ ├── text.js
│ ├── threshold.js
│ ├── tiff.js
│ ├── tile.js
│ ├── timeout.js
│ ├── tint.js
│ ├── toBuffer.js
│ ├── toFormat.js
│ ├── trim.js
│ ├── unflatten.js
│ ├── util.js
│ └── webp.js
└── unit.mjs
SYMBOL INDEX (304 symbols across 22 files)
FILE: lib/channel.js
function removeAlpha (line 32) | function removeAlpha () {
function ensureAlpha (line 61) | function ensureAlpha (alpha) {
function extractChannel (line 96) | function extractChannel (channel) {
function joinChannel (line 125) | function joinChannel (images, options) {
function bandbool (line 152) | function bandbool (boolOp) {
FILE: lib/colour.js
function tint (line 34) | function tint (tint) {
function greyscale (line 53) | function greyscale (greyscale) {
function grayscale (line 63) | function grayscale (grayscale) {
function pipelineColourspace (line 87) | function pipelineColourspace (colourspace) {
function pipelineColorspace (line 101) | function pipelineColorspace (colorspace) {
function toColourspace (line 119) | function toColourspace (colourspace) {
function toColorspace (line 133) | function toColorspace (colorspace) {
function _getBackgroundColourOption (line 143) | function _getBackgroundColourOption (value) {
function _setBackgroundColourOption (line 167) | function _setBackgroundColourOption (key, value) {
FILE: lib/composite.js
function composite (line 131) | function composite (images) {
FILE: lib/constructor.js
function clone (line 474) | function clone () {
FILE: lib/index.d.ts
type Sharp (line 180) | interface Sharp extends Duplex {
type SharpInput (line 969) | type SharpInput = Buffer
type SharpOptions (line 982) | interface SharpOptions {
type CacheOptions (line 1049) | interface CacheOptions {
type TimeoutOptions (line 1058) | interface TimeoutOptions {
type SharpCounters (line 1063) | interface SharpCounters {
type Raw (line 1070) | interface Raw {
type CreateRaw (line 1076) | interface CreateRaw extends Raw {
type CreateChannels (line 1083) | type CreateChannels = 3 | 4;
type Create (line 1085) | interface Create {
type CreateText (line 1101) | interface CreateText {
type Join (line 1132) | interface Join {
type TiffInputOptions (line 1147) | interface TiffInputOptions {
type SvgInputOptions (line 1152) | interface SvgInputOptions {
type PdfInputOptions (line 1159) | interface PdfInputOptions {
type OpenSlideInputOptions (line 1164) | interface OpenSlideInputOptions {
type Jp2InputOptions (line 1169) | interface Jp2InputOptions {
type ExifDir (line 1174) | interface ExifDir {
type Exif (line 1178) | interface Exif {
type HeifCompression (line 1185) | type HeifCompression = 'av1' | 'hevc';
type Unit (line 1187) | type Unit = 'inch' | 'cm';
type WriteableMetadata (line 1189) | interface WriteableMetadata {
type Metadata (line 1206) | interface Metadata {
type LevelMetadata (line 1282) | interface LevelMetadata {
type CommentsMetadata (line 1287) | interface CommentsMetadata {
type Stats (line 1292) | interface Stats {
type ChannelStats (line 1305) | interface ChannelStats {
type OutputOptions (line 1328) | interface OutputOptions {
type WithIccProfileOptions (line 1333) | interface WithIccProfileOptions {
type JpegOptions (line 1338) | interface JpegOptions extends OutputOptions {
type Jp2Options (line 1365) | interface Jp2Options extends OutputOptions {
type JxlOptions (line 1378) | interface JxlOptions extends OutputOptions {
type WebpOptions (line 1391) | interface WebpOptions extends OutputOptions, AnimationOptions {
type AvifOptions (line 1414) | interface AvifOptions extends OutputOptions {
type HeifOptions (line 1427) | interface HeifOptions extends OutputOptions {
type GifOptions (line 1442) | interface GifOptions extends OutputOptions, AnimationOptions {
type TiffOptions (line 1463) | interface TiffOptions extends OutputOptions {
type PngOptions (line 1492) | interface PngOptions extends OutputOptions {
type RotateOptions (line 1513) | interface RotateOptions {
type Precision (line 1518) | type Precision = 'integer' | 'float' | 'approximate';
type BlurOptions (line 1520) | interface BlurOptions {
type FlattenOptions (line 1529) | interface FlattenOptions {
type NegateOptions (line 1534) | interface NegateOptions {
type NormaliseOptions (line 1539) | interface NormaliseOptions {
type ResizeOptions (line 1546) | interface ResizeOptions {
type Region (line 1567) | interface Region {
type Noise (line 1578) | interface Noise {
type ExtendWith (line 1587) | type ExtendWith = 'background' | 'copy' | 'repeat' | 'mirror';
type ExtendOptions (line 1589) | interface ExtendOptions {
type TrimOptions (line 1604) | interface TrimOptions {
type RawOptions (line 1613) | interface RawOptions {
type Channels (line 1618) | type Channels = 1 | 2 | 3 | 4;
type RGBA (line 1620) | interface RGBA {
type Colour (line 1627) | type Colour = string | RGBA;
type Color (line 1628) | type Color = Colour;
type Kernel (line 1630) | interface Kernel {
type ClaheOptions (line 1643) | interface ClaheOptions {
type ThresholdOptions (line 1652) | interface ThresholdOptions {
type OverlayOptions (line 1659) | interface OverlayOptions extends SharpOptions {
type TileOptions (line 1686) | interface TileOptions {
type AnimationOptions (line 1713) | interface AnimationOptions {
type SharpenOptions (line 1720) | interface SharpenOptions {
type AffineOptions (line 1735) | interface AffineOptions {
type OutputInfo (line 1750) | interface OutputInfo {
type AvailableFormatInfo (line 1777) | interface AvailableFormatInfo {
type FitEnum (line 1783) | interface FitEnum {
type KernelEnum (line 1791) | interface KernelEnum {
type PresetEnum (line 1802) | interface PresetEnum {
type BoolEnum (line 1811) | interface BoolEnum {
type ColourspaceEnum (line 1817) | interface ColourspaceEnum {
type DepthEnum (line 1839) | interface DepthEnum {
type FailOnOptions (line 1852) | type FailOnOptions = 'none' | 'truncated' | 'error' | 'warning';
type TextAlign (line 1854) | type TextAlign = 'left' | 'centre' | 'center' | 'right';
type TextWrap (line 1856) | type TextWrap = 'word' | 'char' | 'word-char' | 'none';
type HorizontalAlignment (line 1858) | type HorizontalAlignment = 'left' | 'centre' | 'center' | 'right';
type VerticalAlignment (line 1860) | type VerticalAlignment = 'top' | 'centre' | 'center' | 'bottom';
type TileContainer (line 1862) | type TileContainer = 'fs' | 'zip';
type TileLayout (line 1864) | type TileLayout = 'dz' | 'iiif' | 'iiif3' | 'zoomify' | 'google';
type Blend (line 1866) | type Blend =
type Gravity (line 1895) | type Gravity = number | string;
type GravityEnum (line 1897) | interface GravityEnum {
type StrategyEnum (line 1910) | interface StrategyEnum {
type FormatEnum (line 1915) | interface FormatEnum {
type CacheResult (line 1942) | interface CacheResult {
type Interpolators (line 1948) | interface Interpolators {
type Matrix2x2 (line 1966) | type Matrix2x2 = [[number, number], [number, number]];
type Matrix3x3 (line 1967) | type Matrix3x3 = [[number, number, number], [number, number, number], [n...
type Matrix4x4 (line 1968) | type Matrix4x4 = [[number, number, number, number], [number, number, num...
FILE: lib/input.js
function _inputOptionsFromObject (line 40) | function _inputOptionsFromObject (obj) {
function _createInputDescriptor (line 53) | function _createInputDescriptor (input, inputOptions, containerOptions) {
function _write (line 528) | function _write (chunk, _encoding, callback) {
function _flattenBufferIn (line 550) | function _flattenBufferIn () {
function _isStreamInput (line 561) | function _isStreamInput () {
function metadata (line 636) | function metadata (callback) {
function stats (line 738) | function stats (callback) {
FILE: lib/operation.js
function rotate (line 55) | function rotate (angle, options) {
function autoOrient (line 100) | function autoOrient () {
function flip (line 117) | function flip (flip) {
function flop (line 132) | function flop (flop) {
function affine (line 180) | function affine (matrix, options) {
function sharpen (line 274) | function sharpen (options, flat, jagged) {
function median (line 361) | function median (size) {
function blur (line 398) | function blur (options) {
function dilate (line 451) | function dilate (width) {
function erode (line 474) | function erode (width) {
function flatten (line 499) | function flatten (options) {
function unflatten (line 528) | function unflatten () {
function gamma (line 547) | function gamma (gamma, gammaOut) {
function negate (line 584) | function negate (options) {
function normalise (line 619) | function normalise (options) {
function normalize (line 657) | function normalize (options) {
function clahe (line 684) | function clahe (options) {
function convolve (line 734) | function convolve (kernel) {
function threshold (line 767) | function threshold (threshold, options) {
function boolean (line 801) | function boolean (operand, operator, options) {
function linear (line 835) | function linear (a, b) {
function recomb (line 887) | function recomb (inputMatrix) {
function modulate (line 950) | function modulate (options) {
FILE: lib/output.js
function toFile (line 73) | function toFile (fileOut, callback) {
function toBuffer (line 156) | function toBuffer (options, callback) {
function keepExif (line 181) | function keepExif () {
function withExif (line 210) | function withExif (exif) {
function withExifMerge (line 250) | function withExifMerge (exif) {
function keepIccProfile (line 277) | function keepIccProfile () {
function withIccProfile (line 301) | function withIccProfile (icc, options) {
function keepXmp (line 334) | function keepXmp () {
function withXmp (line 365) | function withXmp (xmp) {
function keepMetadata (line 390) | function keepMetadata () {
function withMetadata (line 419) | function withMetadata (options) {
function toFormat (line 461) | function toFormat (format, options) {
function jpeg (line 504) | function jpeg (options) {
function png (line 610) | function png (options) {
function webp (line 697) | function webp (options) {
function gif (line 799) | function gif (options) {
function jp2 (line 888) | function jp2 (options) {
function trySetAnimationOptions (line 943) | function trySetAnimationOptions (source, target) {
function tiff (line 1000) | function tiff (options) {
function avif (line 1119) | function avif (options) {
function heif (line 1146) | function heif (options) {
function jxl (line 1219) | function jxl (options) {
function raw (line 1288) | function raw (options) {
function tile (line 1349) | function tile (options) {
function timeout (line 1469) | function timeout (options) {
function _updateFormatOut (line 1490) | function _updateFormatOut (formatOut, options) {
function _setBooleanOption (line 1504) | function _setBooleanOption (key, val) {
function _read (line 1516) | function _read () {
function _pipeline (line 1529) | function _pipeline (callback, stack) {
FILE: lib/resize.js
function isRotationExpected (line 109) | function isRotationExpected (options) {
function isResizeExpected (line 116) | function isResizeExpected (options) {
function resize (line 258) | function resize (widthOrOptions, height, options) {
function extend (line 398) | function extend (extend) {
function extract (line 477) | function extract (options) {
function trim (line 550) | function trim (options) {
FILE: lib/utility.js
function cache (line 104) | function cache (options) {
function concurrency (line 150) | function concurrency (concurrency) {
function counters (line 184) | function counters () {
function simd (line 205) | function simd (simd) {
function block (line 225) | function block (options) {
function unblock (line 263) | function unblock (options) {
FILE: src/common.cc
type sharp (line 23) | namespace sharp {
function HasAttr (line 26) | bool HasAttr(Napi::Object obj, std::string attr) {
function AttrAsStr (line 29) | std::string AttrAsStr(Napi::Object obj, std::string attr) {
function AttrAsStr (line 32) | std::string AttrAsStr(Napi::Object obj, unsigned int const attr) {
function AttrAsUint32 (line 35) | uint32_t AttrAsUint32(Napi::Object obj, std::string attr) {
function AttrAsInt32 (line 38) | int32_t AttrAsInt32(Napi::Object obj, std::string attr) {
function AttrAsInt32 (line 41) | int32_t AttrAsInt32(Napi::Object obj, unsigned int const attr) {
function AttrAsInt64 (line 44) | int64_t AttrAsInt64(Napi::Object obj, std::string attr) {
function AttrAsDouble (line 47) | double AttrAsDouble(Napi::Object obj, std::string attr) {
function AttrAsDouble (line 50) | double AttrAsDouble(Napi::Object obj, unsigned int const attr) {
function AttrAsBool (line 53) | bool AttrAsBool(Napi::Object obj, std::string attr) {
function AttrAsVectorOfDouble (line 56) | std::vector<double> AttrAsVectorOfDouble(Napi::Object obj, std::string...
function AttrAsInt32Vector (line 64) | std::vector<int32_t> AttrAsInt32Vector(Napi::Object obj, std::string a...
function InputDescriptor (line 74) | InputDescriptor* CreateInputDescriptor(Napi::Object input) {
function EndsWith (line 218) | static bool EndsWith(std::string const &str, std::string const &end) {
function IsJpeg (line 221) | bool IsJpeg(std::string const &str) {
function IsPng (line 224) | bool IsPng(std::string const &str) {
function IsWebp (line 227) | bool IsWebp(std::string const &str) {
function IsGif (line 230) | bool IsGif(std::string const &str) {
function IsJp2 (line 233) | bool IsJp2(std::string const &str) {
function IsTiff (line 237) | bool IsTiff(std::string const &str) {
function IsHeic (line 240) | bool IsHeic(std::string const &str) {
function IsHeif (line 243) | bool IsHeif(std::string const &str) {
function IsAvif (line 246) | bool IsAvif(std::string const &str) {
function IsJxl (line 249) | bool IsJxl(std::string const &str) {
function IsDz (line 252) | bool IsDz(std::string const &str) {
function IsDzZip (line 255) | bool IsDzZip(std::string const &str) {
function IsV (line 258) | bool IsV(std::string const &str) {
function TrimEnd (line 265) | std::string TrimEnd(std::string const &str) {
function ImageTypeId (line 272) | std::string ImageTypeId(ImageType const imageType) {
function ImageType (line 350) | ImageType DetermineImageType(void *buffer, size_t const length) {
function ImageType (line 365) | ImageType DetermineImageType(char const *file) {
function ImageTypeSupportsPage (line 384) | bool ImageTypeSupportsPage(ImageType imageType) {
function ImageTypeSupportsUnlimited (line 398) | bool ImageTypeSupportsUnlimited(ImageType imageType) {
function OpenInput (line 452) | std::tuple<VImage, ImageType> OpenInput(InputDescriptor *descriptor) {
function HasProfile (line 591) | bool HasProfile(VImage image) {
function GetProfile (line 598) | std::pair<char*, size_t> GetProfile(VImage image) {
function VImage (line 613) | VImage SetProfile(VImage image, std::pair<char*, size_t> icc) {
function VImage (line 633) | VImage RemoveExif(VImage image) {
function ExifOrientation (line 645) | int ExifOrientation(VImage image) {
function VImage (line 656) | VImage SetExifOrientation(VImage image, int const orientation) {
function VImage (line 665) | VImage RemoveExifOrientation(VImage image) {
function VImage (line 675) | VImage SetAnimationProperties(VImage image, int nPages, int pageHeight...
function VImage (line 700) | VImage RemoveAnimationProperties(VImage image) {
function VImage (line 711) | VImage RemoveGifPalette(VImage image) {
function HasDensity (line 720) | bool HasDensity(VImage image) {
function GetDensity (line 727) | int GetDensity(VImage image) {
function VImage (line 734) | VImage SetDensity(VImage image, const double density) {
function GetPageHeight (line 746) | int GetPageHeight(VImage image) {
function AssertImageTypeDimensions (line 753) | void AssertImageTypeDimensions(VImage image, ImageType const imageType) {
function VipsWarningCallback (line 792) | void VipsWarningCallback(char const* log_domain, GLogLevelFlags log_le...
function VipsWarningPop (line 800) | std::string VipsWarningPop() {
function SetTimeout (line 813) | void SetTimeout(VImage image, int const seconds) {
function VipsProgressCallBack (line 828) | void VipsProgressCallBack(VipsImage *im, VipsProgress *progress, int *...
function CalculateEmbedPosition (line 842) | std::tuple<int, int> CalculateEmbedPosition(int const inWidth, int con...
function CalculateCrop (line 895) | std::tuple<int, int> CalculateCrop(int const inWidth, int const inHeight,
function CalculateCrop (line 947) | std::tuple<int, int> CalculateCrop(int const inWidth, int const inHeight,
function Is16Bit (line 973) | bool Is16Bit(VipsInterpretation const interpretation) {
function GetRgbaAsColourspace (line 980) | std::vector<double> GetRgbaAsColourspace(std::vector<double> const rgba,
function ApplyAlpha (line 1000) | std::tuple<VImage, std::vector<double>> ApplyAlpha(VImage image, std::...
function VImage (line 1036) | VImage RemoveAlpha(VImage image) {
function VImage (line 1046) | VImage EnsureAlpha(VImage image, double const value) {
function ResolveShrink (line 1053) | std::pair<double, double> ResolveShrink(int width, int height, int tar...
function VImage (line 1123) | VImage StaySequential(VImage image, bool condition) {
FILE: src/common.h
type InputDescriptor (line 36) | struct InputDescriptor {
type class (line 158) | enum class
function Canvas (line 182) | enum class Canvas {
FILE: src/metadata.cc
class MetadataWorker (line 20) | class MetadataWorker : public Napi::AsyncWorker {
method MetadataWorker (line 22) | MetadataWorker(Napi::Function callback, MetadataBaton *baton, Napi::Fu...
method Execute (line 26) | void Execute() {
method OnOK (line 153) | void OnOK() {
function metadata (line 307) | Napi::Value metadata(const Napi::CallbackInfo& info) {
FILE: src/metadata.h
type std (line 15) | typedef std::vector<std::pair<std::string, std::string>> MetadataComments;
FILE: src/operations.cc
type sharp (line 19) | namespace sharp {
function VImage (line 23) | VImage Tint(VImage image, std::vector<double> const tint) {
function VImage (line 64) | VImage Normalise(VImage image, int const lower, int const upper) {
function VImage (line 103) | VImage Clahe(VImage image, int const width, int const height, int cons...
function VImage (line 110) | VImage Gamma(VImage image, double const exponent) {
function VImage (line 123) | VImage Flatten(VImage image, std::vector<double> flattenBackground) {
function VImage (line 136) | VImage Negate(VImage image, bool const negateAlpha) {
function VImage (line 149) | VImage Blur(VImage image, double const sigma, VipsPrecision precision,...
function VImage (line 169) | VImage Convolve(VImage image, int const width, int const height,
function VImage (line 190) | VImage Recomb(VImage image, std::vector<double> const& matrix) {
function VImage (line 207) | VImage Modulate(VImage image, double const brightness, double const sa...
function VImage (line 235) | VImage Sharpen(VImage image, double const sigma, double const m1, doub...
function VImage (line 263) | VImage Threshold(VImage image, double const threshold, bool const thre...
function VImage (line 273) | VImage Bandbool(VImage image, VipsOperationBoolean const boolean) {
function VImage (line 281) | VImage Boolean(VImage image, VImage imageR, VipsOperationBoolean const...
function VImage (line 288) | VImage Trim(VImage image, std::vector<double> background, double thres...
function VImage (line 343) | VImage Linear(VImage image, std::vector<double> const a, std::vector<d...
function VImage (line 361) | VImage Unflatten(VImage image) {
function VImage (line 374) | VImage EnsureColourspace(VImage image, VipsInterpretation colourspace) {
function VImage (line 385) | VImage CropMultiPage(VImage image, int left, int top, int width, int h...
function VImage (line 415) | VImage EmbedMultiPage(VImage image, int left, int top, int width, int ...
function VImage (line 480) | VImage Dilate(VImage image, int const width) {
function VImage (line 491) | VImage Erode(VImage image, int const width) {
FILE: src/operations.h
function namespace (line 18) | namespace sharp {
FILE: src/pipeline.cc
class PipelineWorker (line 26) | class PipelineWorker : public Napi::AsyncWorker {
method PipelineWorker (line 28) | PipelineWorker(Napi::Function callback, PipelineBaton *baton,
method Execute (line 37) | void Execute() {
method OnOK (line 1283) | void OnOK() {
method MultiPageUnsupported (line 1387) | void MultiPageUnsupported(int const pages, std::string op) {
method CalculateExifRotationAndFlop (line 1397) | std::tuple<VipsAngle, bool>
method VipsAngle (line 1417) | VipsAngle
method AssembleSuffixString (line 1435) | std::string
method Error (line 1513) | void Error() {
function pipeline (line 1523) | Napi::Value pipeline(const Napi::CallbackInfo& info) {
FILE: src/sharp.cc
function init (line 17) | Napi::Object init(Napi::Env env, Napi::Object exports) {
FILE: src/stats.cc
class StatsWorker (line 17) | class StatsWorker : public Napi::AsyncWorker {
method StatsWorker (line 19) | StatsWorker(Napi::Function callback, StatsBaton *baton, Napi::Function...
method Execute (line 34) | void Execute() {
method OnOK (line 105) | void OnOK() {
function stats (line 164) | Napi::Value stats(const Napi::CallbackInfo& info) {
FILE: src/utilities.cc
function cache (line 21) | Napi::Value cache(const Napi::CallbackInfo& info) {
function concurrency (line 62) | Napi::Value concurrency(const Napi::CallbackInfo& info) {
function counters (line 74) | Napi::Value counters(const Napi::CallbackInfo& info) {
function simd (line 84) | Napi::Value simd(const Napi::CallbackInfo& info) {
function libvipsVersion (line 96) | Napi::Value libvipsVersion(const Napi::CallbackInfo& info) {
function format (line 119) | Napi::Value format(const Napi::CallbackInfo& info) {
function block (line 187) | void block(const Napi::CallbackInfo& info) {
function _maxColourDistance (line 200) | Napi::Value _maxColourDistance(const Napi::CallbackInfo& info) {
function _isUsingJemalloc (line 262) | Napi::Value _isUsingJemalloc(const Napi::CallbackInfo& info) {
function _isUsingJemalloc (line 267) | Napi::Value _isUsingJemalloc(const Napi::CallbackInfo& info) {
function _isUsingX64V2 (line 275) | Napi::Value _isUsingX64V2(const Napi::CallbackInfo& info) {
function _isUsingX64V2 (line 284) | Napi::Value _isUsingX64V2(const Napi::CallbackInfo& info) {
FILE: test/fixtures/index.js
function fingerprint (line 15) | async function fingerprint (image) {
FILE: test/unit/stats.js
function isInAcceptableRange (line 15) | function isInAcceptableRange (actual, expected) {
function isInRange (line 18) | function isInRange (actual, min, max) {
function isInteger (line 21) | function isInteger (val) {
Condensed preview — 278 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (1,471K chars).
[
{
"path": ".cirrus.yml",
"chars": 422,
"preview": "freebsd_instance:\n image_family: freebsd-16-0-snap\n\ntask:\n name: FreeBSD\n env:\n IGNORE_OSVERSION: yes\n skip_notif"
},
{
"path": ".editorconfig",
"chars": 178,
"preview": "# http://editorconfig.org\nroot = true\n\n[*]\nindent_style = space\nindent_size = 2\ncharset = utf-8\ntrim_trailing_whitespace"
},
{
"path": ".github/CONTRIBUTING.md",
"chars": 3479,
"preview": "# Contributing to sharp\n\nHello, thank you for your interest in helping!\n\n## Submit a new bug report\n\nPlease create a [ne"
},
{
"path": ".github/FUNDING.yml",
"chars": 25,
"preview": "open_collective: libvips\n"
},
{
"path": ".github/ISSUE_TEMPLATE/config.yml",
"chars": 199,
"preview": "blank_issues_enabled: false\ncontact_links:\n - name: Documentation\n url: https://sharp.pixelplumbing.com/\n about: "
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.md",
"chars": 622,
"preview": "---\nname: Feature request\nabout: Suggest an idea\nlabels: enhancement\n\n---\n\n## Feature request\n\n### What are you trying t"
},
{
"path": ".github/ISSUE_TEMPLATE/installation.md",
"chars": 2565,
"preview": "---\nname: Installation\nabout: Something went wrong during either 'npm install sharp' or 'require(\"sharp\")'\nlabels: insta"
},
{
"path": ".github/ISSUE_TEMPLATE/possible-bug.md",
"chars": 2739,
"preview": "---\nname: Possible bug\nabout: Installation of sharp was successful but then something unexpected occurred using one of i"
},
{
"path": ".github/ISSUE_TEMPLATE/question.md",
"chars": 851,
"preview": "---\nname: Question\nabout: For help understanding an existing feature\nlabels: question\n\n---\n\n<!-- If this issue relates t"
},
{
"path": ".github/SECURITY.md",
"chars": 427,
"preview": "# Security Policy\n\n## Supported Versions\n\nThe latest version of `sharp` as published to npm\nand reported by `npm view sh"
},
{
"path": ".github/workflows/ci.yml",
"chars": 12566,
"preview": "name: CI\non:\n - push\n - pull_request\npermissions: {}\njobs:\n lint:\n permissions:\n contents: read\n runs-on: "
},
{
"path": ".github/workflows/npm.yml",
"chars": 5884,
"preview": "name: \"CI: npm smoke test\"\n\non:\n push:\n tags:\n - \"v**\"\n\npermissions: {}\n\njobs:\n release-smoke-test:\n name: "
},
{
"path": ".gitignore",
"chars": 280,
"preview": "src/build\nsrc/node_modules\nnode_modules\n/coverage\nnpm/*/*\n!npm/*/package.json\ntest/bench/node_modules\ntest/fixtures/outp"
},
{
"path": "LICENSE",
"chars": 10273,
"preview": "Apache License\nVersion 2.0, January 2004\nhttp://www.apache.org/licenses/\n\nTERMS AND CONDITIONS FOR USE, REPRODUCTION, AN"
},
{
"path": "README.md",
"chars": 3160,
"preview": "# sharp\n\n<img src=\"https://sharp.pixelplumbing.com/sharp-logo.svg\" width=\"160\" height=\"160\" alt=\"sharp logo\" align=\"righ"
},
{
"path": "biome.json",
"chars": 433,
"preview": "{\n \"$schema\": \"https://biomejs.dev/schemas/2.3.4/schema.json\",\n \"vcs\": {\n \"enabled\": true,\n \"clientKind\": \"git\","
},
{
"path": "docs/astro.config.mjs",
"chars": 3168,
"preview": "// @ts-check\nimport starlight from '@astrojs/starlight';\nimport { defineConfig } from 'astro/config';\nimport starlightAu"
},
{
"path": "docs/build.mjs",
"chars": 1333,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nimport fs from 'node:fs/promise"
},
{
"path": "docs/firebase.json",
"chars": 367,
"preview": "{\n \"hosting\": {\n \"site\": \"pixelplumbing-sharp\",\n \"public\": \"dist\",\n \"headers\": [\n {\n \"source\": \"**"
},
{
"path": "docs/package.json",
"chars": 364,
"preview": "{\n \"name\": \"sharp-docs\",\n \"type\": \"module\",\n \"version\": \"0.0.1\",\n \"private\": true,\n \"scripts\": {\n \"dev\": \"astro "
},
{
"path": "docs/public/humans.txt",
"chars": 6321,
"preview": "/* THANKS */\n\nName: John Cupitt\nGitHub: https://github.com/jcupitt\n\nName: Pierre Inglebert\nGitHub: https://github.com/pi"
},
{
"path": "docs/public/robots.txt",
"chars": 84,
"preview": "User-agent: *\nDisallow:\n\nSitemap: https://sharp.pixelplumbing.com/sitemap-index.xml\n"
},
{
"path": "docs/src/content/docs/api-channel.md",
"chars": 3981,
"preview": "---\n# This file was auto-generated from JSDoc in lib/channel.js\ntitle: Channel manipulation\n---\n\n## removeAlpha\n> remove"
},
{
"path": "docs/src/content/docs/api-colour.md",
"chars": 3642,
"preview": "---\n# This file was auto-generated from JSDoc in lib/colour.js\ntitle: Colour manipulation\n---\n\n## tint\n> tint(tint) ⇒ <c"
},
{
"path": "docs/src/content/docs/api-composite.md",
"chars": 6285,
"preview": "---\n# This file was auto-generated from JSDoc in lib/composite.js\ntitle: Compositing images\n---\n\n## composite\n> composit"
},
{
"path": "docs/src/content/docs/api-constructor.md",
"chars": 15078,
"preview": "---\n# This file was auto-generated from JSDoc in lib/constructor.js\ntitle: Constructor\n---\n\n## Sharp\n> Sharp\n\n\n**Emits**"
},
{
"path": "docs/src/content/docs/api-input.md",
"chars": 6430,
"preview": "---\n# This file was auto-generated from JSDoc in lib/input.js\ntitle: Input metadata\n---\n\n## metadata\n> metadata([callbac"
},
{
"path": "docs/src/content/docs/api-operation.md",
"chars": 20379,
"preview": "---\n# This file was auto-generated from JSDoc in lib/operation.js\ntitle: Image operations\n---\n\n## rotate\n> rotate([angle"
},
{
"path": "docs/src/content/docs/api-output.md",
"chars": 31348,
"preview": "---\n# This file was auto-generated from JSDoc in lib/output.js\ntitle: Output options\n---\n\n## toFile\n> toFile(fileOut, [c"
},
{
"path": "docs/src/content/docs/api-resize.md",
"chars": 12873,
"preview": "---\n# This file was auto-generated from JSDoc in lib/resize.js\ntitle: Resizing images\n---\n\n## resize\n> resize([width], ["
},
{
"path": "docs/src/content/docs/api-utility.md",
"chars": 6778,
"preview": "---\n# This file was auto-generated from JSDoc in lib/utility.js\ntitle: Global properties\n---\n\n## versions\n> versions\n\nAn"
},
{
"path": "docs/src/content/docs/changelog/_meta.yml",
"chars": 19,
"preview": "sort: reverse-slug\n"
},
{
"path": "docs/src/content/docs/changelog/v0.10.0.md",
"chars": 872,
"preview": "---\ntitle: v0.10.0 - 23rd April 2015\nslug: changelog/v0.10.0\n---\n\n* Add support for Windows (x86).\n [#19](https://githu"
},
{
"path": "docs/src/content/docs/changelog/v0.10.1.md",
"chars": 416,
"preview": "---\ntitle: v0.10.1 - 1st June 2015\nslug: changelog/v0.10.1\n---\n\n* Allow embed of image with alpha transparency onto non-"
},
{
"path": "docs/src/content/docs/changelog/v0.11.0.md",
"chars": 1231,
"preview": "---\ntitle: v0.11.0 - 15th July 2015\nslug: changelog/v0.11.0\n---\n\n* Allow alpha transparency compositing via new `overlay"
},
{
"path": "docs/src/content/docs/changelog/v0.11.1.md",
"chars": 424,
"preview": "---\ntitle: v0.11.1 - 12th August 2015\nslug: changelog/v0.11.1\n---\n\n* Silence MSVC warning: \"C4530: C++ exception handler"
},
{
"path": "docs/src/content/docs/changelog/v0.11.2.md",
"chars": 307,
"preview": "---\ntitle: v0.11.2 - 28th August 2015\nslug: changelog/v0.11.2\n---\n\n* Allow crop gravity to be provided as a String.\n [#"
},
{
"path": "docs/src/content/docs/changelog/v0.11.3.md",
"chars": 242,
"preview": "---\ntitle: v0.11.3 - 8th September 2015\nslug: changelog/v0.11.3\n---\n\n* Intrepret blurSigma, sharpenFlat, and sharpenJagg"
},
{
"path": "docs/src/content/docs/changelog/v0.11.4.md",
"chars": 561,
"preview": "---\ntitle: v0.11.4 - 5th November 2015\nslug: changelog/v0.11.4\n---\n\n* Add corners, e.g. `northeast`, to existing `gravit"
},
{
"path": "docs/src/content/docs/changelog/v0.12.0.md",
"chars": 1345,
"preview": "---\ntitle: v0.12.0 - 23rd November 2015\nslug: changelog/v0.12.0\n---\n\n* Bundle pre-compiled libvips and its dependencies "
},
{
"path": "docs/src/content/docs/changelog/v0.12.1.md",
"chars": 491,
"preview": "---\ntitle: v0.12.1 - 12th December 2015\nslug: changelog/v0.12.1\n---\n\n* Allow use of SIMD vector instructions (via liborc"
},
{
"path": "docs/src/content/docs/changelog/v0.12.2.md",
"chars": 621,
"preview": "---\ntitle: v0.12.2 - 16th January 2016\nslug: changelog/v0.12.2\n---\n\n* Upgrade libvips to v8.2.0 for improved vips_shrink"
},
{
"path": "docs/src/content/docs/changelog/v0.13.0.md",
"chars": 1912,
"preview": "---\ntitle: v0.13.0 - 15th February 2016\nslug: changelog/v0.13.0\n---\n\n* Improve vector image support by allowing control "
},
{
"path": "docs/src/content/docs/changelog/v0.13.1.md",
"chars": 255,
"preview": "---\ntitle: v0.13.1 - 27th February 2016\nslug: changelog/v0.13.1\n---\n\n* Fix embedding onto transparent backgrounds; regre"
},
{
"path": "docs/src/content/docs/changelog/v0.14.0.md",
"chars": 1554,
"preview": "---\ntitle: v0.14.0 - 2nd April 2016\nslug: changelog/v0.14.0\n---\n\n* Add ability to extend (pad) the edges of an image.\n "
},
{
"path": "docs/src/content/docs/changelog/v0.14.1.md",
"chars": 983,
"preview": "---\ntitle: v0.14.1 - 16th April 2016\nslug: changelog/v0.14.1\n---\n\n* Allow removal of limitation on input pixel count via"
},
{
"path": "docs/src/content/docs/changelog/v0.15.0.md",
"chars": 807,
"preview": "---\ntitle: v0.15.0 - 21st May 2016\nslug: changelog/v0.15.0\n---\n\n* Use libvips' new Lanczos 3 kernel as default for image"
},
{
"path": "docs/src/content/docs/changelog/v0.15.1.md",
"chars": 2631,
"preview": "---\ntitle: v0.15.1 - 12th July 2016\nslug: changelog/v0.15.1\n---\n\n* Concat Stream-based input in single operation for ~+3"
},
{
"path": "docs/src/content/docs/changelog/v0.16.0.md",
"chars": 1599,
"preview": "---\ntitle: v0.16.0 - 18th August 2016\nslug: changelog/v0.16.0\n---\n\n* Add pre-compiled libvips for OS X, ARMv7 and ARMv8."
},
{
"path": "docs/src/content/docs/changelog/v0.16.1.md",
"chars": 762,
"preview": "---\ntitle: v0.16.1 - 13th October 2016\nslug: changelog/v0.16.1\n---\n\n* C++11 ABI version is now auto-detected, remove sha"
},
{
"path": "docs/src/content/docs/changelog/v0.16.2.md",
"chars": 236,
"preview": "---\ntitle: v0.16.2 - 22nd October 2016\nslug: changelog/v0.16.2\n---\n\n* Restrict readelf usage to Linux only when detectin"
},
{
"path": "docs/src/content/docs/changelog/v0.17.0.md",
"chars": 1627,
"preview": "---\ntitle: v0.17.0 - 11th December 2016\nslug: changelog/v0.17.0\n---\n\n* Drop support for versions of Node prior to v4.\n\n*"
},
{
"path": "docs/src/content/docs/changelog/v0.17.1.md",
"chars": 495,
"preview": "---\ntitle: v0.17.1 - 15th January 2017\nslug: changelog/v0.17.1\n---\n\n* Improve error messages for invalid parameters.\n ["
},
{
"path": "docs/src/content/docs/changelog/v0.17.2.md",
"chars": 419,
"preview": "---\ntitle: v0.17.2 - 11th February 2017\nslug: changelog/v0.17.2\n---\n\n* Ensure Readable side of Stream can start flowing "
},
{
"path": "docs/src/content/docs/changelog/v0.17.3.md",
"chars": 717,
"preview": "---\ntitle: v0.17.3 - 1st April 2017\nslug: changelog/v0.17.3\n---\n\n* Allow toBuffer to optionally resolve a Promise with b"
},
{
"path": "docs/src/content/docs/changelog/v0.18.0.md",
"chars": 2440,
"preview": "---\ntitle: v0.18.0 - 30th May 2017\nslug: changelog/v0.18.0\n---\n\n* Remove the previously-deprecated output format \"option"
},
{
"path": "docs/src/content/docs/changelog/v0.18.1.md",
"chars": 235,
"preview": "---\ntitle: v0.18.1 - 30th May 2017\nslug: changelog/v0.18.1\n---\n\n* Remove regression from #781 that could cause incorrect"
},
{
"path": "docs/src/content/docs/changelog/v0.18.2.md",
"chars": 629,
"preview": "---\ntitle: v0.18.2 - 1st July 2017\nslug: changelog/v0.18.2\n---\n\n* Expose libvips' xres and yres properties for TIFF outp"
},
{
"path": "docs/src/content/docs/changelog/v0.18.3.md",
"chars": 349,
"preview": "---\ntitle: v0.18.3 - 13th September 2017\nslug: changelog/v0.18.3\n---\n\n* Skip shrink-on-load when trimming.\n [#888](http"
},
{
"path": "docs/src/content/docs/changelog/v0.18.4.md",
"chars": 246,
"preview": "---\ntitle: v0.18.4 - 18th September 2017\nslug: changelog/v0.18.4\n---\n\n* Ensure input Buffer really is marked as Persiste"
},
{
"path": "docs/src/content/docs/changelog/v0.19.0.md",
"chars": 1877,
"preview": "---\ntitle: v0.19.0 - 11th January 2018\nslug: changelog/v0.19.0\n---\n\n* Expose offset coordinates of strategy-based crop.\n"
},
{
"path": "docs/src/content/docs/changelog/v0.19.1.md",
"chars": 509,
"preview": "---\ntitle: v0.19.1 - 24th February 2018\nslug: changelog/v0.19.1\n---\n\n* Expose libvips' linear transform feature.\n [#102"
},
{
"path": "docs/src/content/docs/changelog/v0.20.0.md",
"chars": 181,
"preview": "---\ntitle: v0.20.0 - 5th March 2018\nslug: changelog/v0.20.0\n---\n\n* Add support for prebuilt sharp binaries on common pla"
},
{
"path": "docs/src/content/docs/changelog/v0.20.1.md",
"chars": 540,
"preview": "---\ntitle: v0.20.1 - 17th March 2018\nslug: changelog/v0.20.1\n---\n\n* Improve installation experience when a globally-inst"
},
{
"path": "docs/src/content/docs/changelog/v0.20.2.md",
"chars": 692,
"preview": "---\ntitle: v0.20.2 - 28th April 2018\nslug: changelog/v0.20.2\n---\n\n* Add tint operation to set image chroma.\n [#825](htt"
},
{
"path": "docs/src/content/docs/changelog/v0.20.3.md",
"chars": 242,
"preview": "---\ntitle: v0.20.3 - 29th May 2018\nslug: changelog/v0.20.3\n---\n\n* Fix tint operation by ensuring LAB interpretation and "
},
{
"path": "docs/src/content/docs/changelog/v0.20.4.md",
"chars": 437,
"preview": "---\ntitle: v0.20.4 - 20th June 2018\nslug: changelog/v0.20.4\n---\n\n* Prevent possible rounding error when using shrink-on-"
},
{
"path": "docs/src/content/docs/changelog/v0.20.5.md",
"chars": 206,
"preview": "---\ntitle: v0.20.5 - 27th June 2018\nslug: changelog/v0.20.5\n---\n\n* Expose libjpeg optimize_coding flag.\n [#1265](https:"
},
{
"path": "docs/src/content/docs/changelog/v0.20.6.md",
"chars": 1113,
"preview": "---\ntitle: v0.20.6 - 20th August 2018\nslug: changelog/v0.20.6\n---\n\n* Add removeAlpha operation to remove alpha channel, "
},
{
"path": "docs/src/content/docs/changelog/v0.20.7.md",
"chars": 187,
"preview": "---\ntitle: v0.20.7 - 21st August 2018\nslug: changelog/v0.20.7\n---\n\n* Use copy+unlink if rename operation fails during in"
},
{
"path": "docs/src/content/docs/changelog/v0.20.8.md",
"chars": 387,
"preview": "---\ntitle: v0.20.8 - 5th September 2018\nslug: changelog/v0.20.8\n---\n\n* Avoid race conditions when creating directories d"
},
{
"path": "docs/src/content/docs/changelog/v0.21.0.md",
"chars": 1638,
"preview": "---\ntitle: v0.21.0 - 4th October 2018\nslug: changelog/v0.21.0\n---\n\n* Deprecate the following resize-related functions:\n "
},
{
"path": "docs/src/content/docs/changelog/v0.21.1.md",
"chars": 1134,
"preview": "---\ntitle: v0.21.1 - 7th December 2018\nslug: changelog/v0.21.1\n---\n\n* Install: support `sharp_dist_base_url` npm config,"
},
{
"path": "docs/src/content/docs/changelog/v0.21.2.md",
"chars": 963,
"preview": "---\ntitle: v0.21.2 - 13th January 2019\nslug: changelog/v0.21.2\n---\n\n* Ensure all metadata is removed from PNG output unl"
},
{
"path": "docs/src/content/docs/changelog/v0.21.3.md",
"chars": 293,
"preview": "---\ntitle: v0.21.3 - 19th January 2019\nslug: changelog/v0.21.3\n---\n\n* Input image decoding now fails fast, set `failOnEr"
},
{
"path": "docs/src/content/docs/changelog/v0.22.0.md",
"chars": 731,
"preview": "---\ntitle: v0.22.0 - 18th March 2019\nslug: changelog/v0.22.0\n---\n\n* Remove functions previously deprecated in v0.21.0:\n "
},
{
"path": "docs/src/content/docs/changelog/v0.22.1.md",
"chars": 478,
"preview": "---\ntitle: v0.22.1 - 25th April 2019\nslug: changelog/v0.22.1\n---\n\n* Add `modulate` operation for brightness, saturation "
},
{
"path": "docs/src/content/docs/changelog/v0.23.0.md",
"chars": 1128,
"preview": "---\ntitle: v0.23.0 - 29th July 2019\nslug: changelog/v0.23.0\n---\n\n* Remove `overlayWith` previously deprecated in v0.22.0"
},
{
"path": "docs/src/content/docs/changelog/v0.23.1.md",
"chars": 882,
"preview": "---\ntitle: v0.23.1 - 26th September 2019\nslug: changelog/v0.23.1\n---\n\n* Ensure `sharp.format.vips` is present and correc"
},
{
"path": "docs/src/content/docs/changelog/v0.23.2.md",
"chars": 339,
"preview": "---\ntitle: v0.23.2 - 28th October 2019\nslug: changelog/v0.23.2\n---\n\n* Add `background` option to tile output operation.\n"
},
{
"path": "docs/src/content/docs/changelog/v0.23.3.md",
"chars": 645,
"preview": "---\ntitle: v0.23.3 - 17th November 2019\nslug: changelog/v0.23.3\n---\n\n* Ensure `trim` operation supports images contained"
},
{
"path": "docs/src/content/docs/changelog/v0.23.4.md",
"chars": 357,
"preview": "---\ntitle: v0.23.4 - 5th December 2019\nslug: changelog/v0.23.4\n---\n\n* Handle zero-length Buffer objects when using Node."
},
{
"path": "docs/src/content/docs/changelog/v0.24.0.md",
"chars": 1027,
"preview": "---\ntitle: v0.24.0 - 16th January 2020\nslug: changelog/v0.24.0\n---\n\n* Drop support for Node.js 8.\n [#1910](https://gith"
},
{
"path": "docs/src/content/docs/changelog/v0.24.1.md",
"chars": 299,
"preview": "---\ntitle: v0.24.1 - 15th February 2020\nslug: changelog/v0.24.1\n---\n\n* Prevent use of sequentialRead for EXIF-based rota"
},
{
"path": "docs/src/content/docs/changelog/v0.25.0.md",
"chars": 576,
"preview": "---\ntitle: v0.25.0 - 7th March 2020\nslug: changelog/v0.25.0\n---\n\n* Remove `limitInputPixels` and `sequentialRead` previo"
},
{
"path": "docs/src/content/docs/changelog/v0.25.1.md",
"chars": 183,
"preview": "---\ntitle: v0.25.1 - 7th March 2020\nslug: changelog/v0.25.1\n---\n\n* Ensure prebuilt binaries are fetched based on N-API v"
},
{
"path": "docs/src/content/docs/changelog/v0.25.2.md",
"chars": 598,
"preview": "---\ntitle: v0.25.2 - 20th March 2020\nslug: changelog/v0.25.2\n---\n\n* Provide prebuilt binaries for Linux ARM64v8.\n\n* Add "
},
{
"path": "docs/src/content/docs/changelog/v0.25.3.md",
"chars": 470,
"preview": "---\ntitle: v0.25.3 - 17th May 2020\nslug: changelog/v0.25.3\n---\n\n* Ensure libvips is initialised only once, improves work"
},
{
"path": "docs/src/content/docs/changelog/v0.25.4.md",
"chars": 950,
"preview": "---\ntitle: v0.25.4 - 12th June 2020\nslug: changelog/v0.25.4\n---\n\n* Allow libvips binary location override where version "
},
{
"path": "docs/src/content/docs/changelog/v0.26.0.md",
"chars": 1217,
"preview": "---\ntitle: v0.26.0 - 25th August 2020\nslug: changelog/v0.26.0\n---\n\n* Prebuilt libvips binaries are now statically-linked"
},
{
"path": "docs/src/content/docs/changelog/v0.26.1.md",
"chars": 768,
"preview": "---\ntitle: v0.26.1 - 20th September 2020\nslug: changelog/v0.26.1\n---\n\n* Ensure correct pageHeight when verifying multi-p"
},
{
"path": "docs/src/content/docs/changelog/v0.26.2.md",
"chars": 455,
"preview": "---\ntitle: v0.26.2 - 14th October 2020\nslug: changelog/v0.26.2\n---\n\n* Add support for EXR input. Requires libvips compil"
},
{
"path": "docs/src/content/docs/changelog/v0.26.3.md",
"chars": 367,
"preview": "---\ntitle: v0.26.3 - 16th November 2020\nslug: changelog/v0.26.3\n---\n\n* Expose libvips' affine operation.\n [#2336](https"
},
{
"path": "docs/src/content/docs/changelog/v0.27.0.md",
"chars": 463,
"preview": "---\ntitle: v0.27.0 - 22nd December 2020\nslug: changelog/v0.27.0\n---\n\n* Add support for AVIF to prebuilt binaries.\n\n* Rem"
},
{
"path": "docs/src/content/docs/changelog/v0.27.1.md",
"chars": 655,
"preview": "---\ntitle: v0.27.1 - 27th January 2021\nslug: changelog/v0.27.1\n---\n\n* Ensure TIFF is cast when using float predictor.\n "
},
{
"path": "docs/src/content/docs/changelog/v0.27.2.md",
"chars": 767,
"preview": "---\ntitle: v0.27.2 - 22nd February 2021\nslug: changelog/v0.27.2\n---\n\n* macOS: Prevent use of globally-installed ARM64 li"
},
{
"path": "docs/src/content/docs/changelog/v0.28.0.md",
"chars": 1184,
"preview": "---\ntitle: v0.28.0 - 29th March 2021\nslug: changelog/v0.28.0\n---\n\n* Prebuilt binaries now include mozjpeg and libimagequ"
},
{
"path": "docs/src/content/docs/changelog/v0.28.1.md",
"chars": 482,
"preview": "---\ntitle: v0.28.1 - 5th April 2021\nslug: changelog/v0.28.1\n---\n\n* Ensure all installation errors are logged with a more"
},
{
"path": "docs/src/content/docs/changelog/v0.28.2.md",
"chars": 856,
"preview": "---\ntitle: v0.28.2 - 10th May 2021\nslug: changelog/v0.28.2\n---\n\n* Allow `withMetadata` to set `density`.\n [#967](https:"
},
{
"path": "docs/src/content/docs/changelog/v0.28.3.md",
"chars": 410,
"preview": "---\ntitle: v0.28.3 - 24th May 2021\nslug: changelog/v0.28.3\n---\n\n* Ensure presence of libvips, vendored or global, before"
},
{
"path": "docs/src/content/docs/changelog/v0.29.0.md",
"chars": 1279,
"preview": "---\ntitle: v0.29.0 - 17th August 2021\nslug: changelog/v0.29.0\n---\n\n* Drop support for Node.js 10, now requires Node.js >"
},
{
"path": "docs/src/content/docs/changelog/v0.29.1.md",
"chars": 1038,
"preview": "---\ntitle: v0.29.1 - 7th September 2021\nslug: changelog/v0.29.1\n---\n\n* Add `lightness` option to `modulate` operation.\n "
},
{
"path": "docs/src/content/docs/changelog/v0.29.2.md",
"chars": 691,
"preview": "---\ntitle: v0.29.2 - 21st October 2021\nslug: changelog/v0.29.2\n---\n\n* Add `timeout` function to limit processing time.\n\n"
},
{
"path": "docs/src/content/docs/changelog/v0.29.3.md",
"chars": 356,
"preview": "---\ntitle: v0.29.3 - 14th November 2021\nslug: changelog/v0.29.3\n---\n\n* Ensure correct dimensions when containing image r"
},
{
"path": "docs/src/content/docs/changelog/v0.30.0.md",
"chars": 1722,
"preview": "---\ntitle: v0.30.0 - 1st February 2022\nslug: changelog/v0.30.0\n---\n\n* Add support for GIF output to prebuilt binaries.\n\n"
},
{
"path": "docs/src/content/docs/changelog/v0.30.1.md",
"chars": 663,
"preview": "---\ntitle: v0.30.1 - 9th February 2022\nslug: changelog/v0.30.1\n---\n\n* Allow use of `toBuffer` and `toFile` on the same i"
},
{
"path": "docs/src/content/docs/changelog/v0.30.2.md",
"chars": 596,
"preview": "---\ntitle: v0.30.2 - 2nd March 2022\nslug: changelog/v0.30.2\n---\n\n* Improve performance and accuracy when compositing mul"
},
{
"path": "docs/src/content/docs/changelog/v0.30.3.md",
"chars": 457,
"preview": "---\ntitle: v0.30.3 - 14th March 2022\nslug: changelog/v0.30.3\n---\n\n* Allow `sharpen` options to be provided more consiste"
},
{
"path": "docs/src/content/docs/changelog/v0.30.4.md",
"chars": 794,
"preview": "---\ntitle: v0.30.4 - 18th April 2022\nslug: changelog/v0.30.4\n---\n\n* Increase control over sensitivity to invalid images "
},
{
"path": "docs/src/content/docs/changelog/v0.30.5.md",
"chars": 675,
"preview": "---\ntitle: v0.30.5 - 23rd May 2022\nslug: changelog/v0.30.5\n---\n\n* Install: pass `PKG_CONFIG_PATH` via env rather than su"
},
{
"path": "docs/src/content/docs/changelog/v0.30.6.md",
"chars": 304,
"preview": "---\ntitle: v0.30.6 - 30th May 2022\nslug: changelog/v0.30.6\n---\n\n* Allow values for `limitInputPixels` larger than 32-bit"
},
{
"path": "docs/src/content/docs/changelog/v0.30.7.md",
"chars": 458,
"preview": "---\ntitle: v0.30.7 - 22nd June 2022\nslug: changelog/v0.30.7\n---\n\n* Ensure tiled composition always works with outside re"
},
{
"path": "docs/src/content/docs/changelog/v0.31.0.md",
"chars": 2601,
"preview": "---\ntitle: v0.31.0 - 5th September 2022\nslug: changelog/v0.31.0\n---\n\n* Drop support for Node.js 12, now requires Node.js"
},
{
"path": "docs/src/content/docs/changelog/v0.31.1.md",
"chars": 767,
"preview": "---\ntitle: v0.31.1 - 29th September 2022\nslug: changelog/v0.31.1\n---\n\n* Upgrade to libvips v8.13.2 for upstream bug fixe"
},
{
"path": "docs/src/content/docs/changelog/v0.31.2.md",
"chars": 379,
"preview": "---\ntitle: v0.31.2 - 4th November 2022\nslug: changelog/v0.31.2\n---\n\n* Upgrade to libvips v8.13.3 for upstream bug fixes."
},
{
"path": "docs/src/content/docs/changelog/v0.31.3.md",
"chars": 1374,
"preview": "---\ntitle: v0.31.3 - 21st December 2022\nslug: changelog/v0.31.3\n---\n\n* Add experimental support for JPEG-XL images. Requ"
},
{
"path": "docs/src/content/docs/changelog/v0.32.0.md",
"chars": 2308,
"preview": "---\ntitle: v0.32.0 - 24th March 2023\nslug: changelog/v0.32.0\n---\n\n* Default to using sequential rather than random acces"
},
{
"path": "docs/src/content/docs/changelog/v0.32.1.md",
"chars": 1126,
"preview": "---\ntitle: v0.32.1 - 27th April 2023\nslug: changelog/v0.32.1\n---\n\n* Add experimental `unflatten` operation.\n [#3461](ht"
},
{
"path": "docs/src/content/docs/changelog/v0.32.2.md",
"chars": 905,
"preview": "---\ntitle: v0.32.2 - 11th July 2023\nslug: changelog/v0.32.2\n---\n\n* Limit HEIF output dimensions to 16384x16384, matches "
},
{
"path": "docs/src/content/docs/changelog/v0.32.3.md",
"chars": 298,
"preview": "---\ntitle: v0.32.3 - 14th July 2023\nslug: changelog/v0.32.3\n---\n\n* Expose `preset` option for WebP output.\n [#3639](htt"
},
{
"path": "docs/src/content/docs/changelog/v0.32.4.md",
"chars": 303,
"preview": "---\ntitle: v0.32.4 - 21st July 2023\nslug: changelog/v0.32.4\n---\n\n* Upgrade to libvips v8.14.3 for upstream bug fixes.\n\n*"
},
{
"path": "docs/src/content/docs/changelog/v0.32.5.md",
"chars": 820,
"preview": "---\ntitle: v0.32.5 - 15th August 2023\nslug: changelog/v0.32.5\n---\n\n* Upgrade to libvips v8.14.4 for upstream bug fixes.\n"
},
{
"path": "docs/src/content/docs/changelog/v0.32.6.md",
"chars": 659,
"preview": "---\ntitle: v0.32.6 - 18th September 2023\nslug: changelog/v0.32.6\n---\n\n* Upgrade to libvips v8.14.5 for upstream bug fixe"
},
{
"path": "docs/src/content/docs/changelog/v0.33.0.md",
"chars": 1696,
"preview": "---\ntitle: v0.33.0 - 29th November 2023\nslug: changelog/v0.33.0\n---\n\n* Drop support for Node.js 14 and 16, now requires "
},
{
"path": "docs/src/content/docs/changelog/v0.33.1.md",
"chars": 447,
"preview": "---\ntitle: v0.33.1 - 17th December 2023\nslug: changelog/v0.33.1\n---\n\n* Add support for Yarn Plug'n'Play filesystem layou"
},
{
"path": "docs/src/content/docs/changelog/v0.33.2.md",
"chars": 523,
"preview": "---\ntitle: v0.33.2 - 12th January 2024\nslug: changelog/v0.33.2\n---\n\n* Upgrade to libvips v8.15.1 for upstream bug fixes."
},
{
"path": "docs/src/content/docs/changelog/v0.33.3.md",
"chars": 742,
"preview": "---\ntitle: v0.33.3 - 23rd March 2024\nslug: changelog/v0.33.3\n---\n\n* Upgrade to libvips v8.15.2 for upstream bug fixes.\n\n"
},
{
"path": "docs/src/content/docs/changelog/v0.33.4.md",
"chars": 1165,
"preview": "---\ntitle: v0.33.4 - 16th May 2024\nslug: changelog/v0.33.4\n---\n\n* Remove experimental status from `pipelineColourspace`."
},
{
"path": "docs/src/content/docs/changelog/v0.33.5.md",
"chars": 1483,
"preview": "---\ntitle: v0.33.5 - 16th August 2024\nslug: changelog/v0.33.5\n---\n\n* Upgrade to libvips v8.15.3 for upstream bug fixes.\n"
},
{
"path": "docs/src/content/docs/changelog/v0.34.0.md",
"chars": 1931,
"preview": "---\ntitle: v0.34.0 - 4th April 2025\nslug: changelog/v0.34.0\n---\n\n* Breaking: Support array of input images to be joined "
},
{
"path": "docs/src/content/docs/changelog/v0.34.1.md",
"chars": 217,
"preview": "---\ntitle: v0.34.1 - 7th April 2025\nslug: changelog/v0.34.1\n---\n\n* TypeScript: Ensure new `autoOrient` property is optio"
},
{
"path": "docs/src/content/docs/changelog/v0.34.2.md",
"chars": 1092,
"preview": "---\ntitle: v0.34.2 - 20th May 2025\nslug: changelog/v0.34.2\n---\n\n* Ensure animated GIF to WebP conversion retains loop (r"
},
{
"path": "docs/src/content/docs/changelog/v0.34.3.md",
"chars": 1169,
"preview": "---\ntitle: v0.34.3 - 10th July 2025\nslug: changelog/v0.34.3\n---\n\n* Upgrade to libvips v8.17.1 for upstream bug fixes.\n\n*"
},
{
"path": "docs/src/content/docs/changelog/v0.34.4.md",
"chars": 1026,
"preview": "---\ntitle: v0.34.4 - 17th September 2025\nslug: changelog/v0.34.4\n---\n\n* Upgrade to libvips v8.17.2 for upstream bug fixe"
},
{
"path": "docs/src/content/docs/changelog/v0.34.5.md",
"chars": 683,
"preview": "---\ntitle: v0.34.5 - 6th November 2025\nslug: changelog/v0.34.5\n---\n\n* Upgrade to libvips v8.17.3 for upstream bug fixes."
},
{
"path": "docs/src/content/docs/index.md",
"chars": 3651,
"preview": "---\ntitle: \"High performance Node.js image processing\"\n---\n\n<img src=\"/sharp-logo.svg\" width=\"160\" height=\"160\" alt=\"sha"
},
{
"path": "docs/src/content/docs/install.md",
"chars": 10121,
"preview": "---\ntitle: Installation\n---\n\nWorks with your choice of JavaScript package manager.\n\n:::caution\nPlease ensure your packag"
},
{
"path": "docs/src/content/docs/performance.md",
"chars": 4999,
"preview": "---\ntitle: Performance\n---\n\n## Parallelism and concurrency\n\nNode.js uses a libuv-managed thread pool when processing asy"
},
{
"path": "docs/src/content.config.ts",
"chars": 494,
"preview": "import { defineCollection } from 'astro:content';\nimport { docsLoader } from '@astrojs/starlight/loaders';\nimport { docs"
},
{
"path": "docs/src/styles/custom.css",
"chars": 1059,
"preview": "@view-transition {\n navigation: auto;\n}\n\n:root {\n --sl-content-width: 60rem;\n --sl-color-accent-low: #072d00;\n --sl-"
},
{
"path": "docs/tsconfig.json",
"chars": 109,
"preview": "{\n \"extends\": \"astro/tsconfigs/strict\",\n \"include\": [\".astro/types.d.ts\", \"**/*\"],\n \"exclude\": [\"dist\"]\n}\n"
},
{
"path": "install/build.js",
"chars": 882,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst {\n useGlobalLibvips,\n g"
},
{
"path": "install/check.js",
"chars": 383,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\ntry {\n const { useGlobalLibvip"
},
{
"path": "lib/channel.js",
"chars": 5379,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst is = require('./is');\n\n/*"
},
{
"path": "lib/colour.js",
"chars": 5310,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst color = require('@img/col"
},
{
"path": "lib/composite.js",
"chars": 8960,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst is = require('./is');\n\n/*"
},
{
"path": "lib/constructor.js",
"chars": 19953,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst util = require('node:util"
},
{
"path": "lib/index.d.ts",
"chars": 91075,
"preview": "/**\n * Copyright 2017 François Nguyen and others.\n *\n * Billy Kwok <https://github.com/billykwok>\n * Bradley Odell <http"
},
{
"path": "lib/index.js",
"chars": 385,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst Sharp = require('./constr"
},
{
"path": "lib/input.js",
"chars": 32979,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst is = require('./is');\ncon"
},
{
"path": "lib/is.js",
"chars": 2930,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n/**\n * Is this value defined an"
},
{
"path": "lib/libvips.js",
"chars": 5947,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst { spawnSync } = require('"
},
{
"path": "lib/operation.js",
"chars": 33282,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst is = require('./is');\n\n/*"
},
{
"path": "lib/output.js",
"chars": 61198,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst path = require('node:path"
},
{
"path": "lib/resize.js",
"chars": 21079,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst is = require('./is');\n\n/*"
},
{
"path": "lib/sharp.js",
"chars": 4044,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n// Inspects the runtime environ"
},
{
"path": "lib/utility.js",
"chars": 9437,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst events = require('node:ev"
},
{
"path": "npm/darwin-arm64/package.json",
"chars": 886,
"preview": "{\n \"name\": \"@img/sharp-darwin-arm64\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with macOS 64-bit"
},
{
"path": "npm/darwin-x64/package.json",
"chars": 869,
"preview": "{\n \"name\": \"@img/sharp-darwin-x64\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with macOS x64\",\n "
},
{
"path": "npm/from-local-build.js",
"chars": 2550,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n// Populate the npm package for"
},
{
"path": "npm/linux-arm/package.json",
"chars": 951,
"preview": "{\n \"name\": \"@img/sharp-linux-arm\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with Linux (glibc) A"
},
{
"path": "npm/linux-arm64/package.json",
"chars": 959,
"preview": "{\n \"name\": \"@img/sharp-linux-arm64\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with Linux (glibc)"
},
{
"path": "npm/linux-ppc64/package.json",
"chars": 954,
"preview": "{\n \"name\": \"@img/sharp-linux-ppc64\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with Linux (glibc)"
},
{
"path": "npm/linux-riscv64/package.json",
"chars": 972,
"preview": "{\n \"name\": \"@img/sharp-linux-riscv64\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with Linux (glib"
},
{
"path": "npm/linux-s390x/package.json",
"chars": 954,
"preview": "{\n \"name\": \"@img/sharp-linux-s390x\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with Linux (glibc)"
},
{
"path": "npm/linux-x64/package.json",
"chars": 942,
"preview": "{\n \"name\": \"@img/sharp-linux-x64\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with Linux (glibc) x"
},
{
"path": "npm/linuxmusl-arm64/package.json",
"chars": 973,
"preview": "{\n \"name\": \"@img/sharp-linuxmusl-arm64\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with Linux (mu"
},
{
"path": "npm/linuxmusl-x64/package.json",
"chars": 956,
"preview": "{\n \"name\": \"@img/sharp-linuxmusl-x64\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with Linux (musl"
},
{
"path": "npm/package.json",
"chars": 355,
"preview": "{\n \"name\": \"@img/sharp\",\n \"version\": \"0.34.5\",\n \"private\": \"true\",\n \"workspaces\": [\n \"darwin-arm64\",\n \"darwin-"
},
{
"path": "npm/release-notes.js",
"chars": 428,
"preview": "const { readFileSync, writeFileSync } = require('node:fs');\n\nconst { version } = require('./package.json');\nconst versio"
},
{
"path": "npm/wasm32/package.json",
"chars": 899,
"preview": "{\n \"name\": \"@img/sharp-wasm32\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with wasm32\",\n \"author"
},
{
"path": "npm/win32-arm64/package.json",
"chars": 884,
"preview": "{\n \"name\": \"@img/sharp-win32-arm64\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with Windows 64-bi"
},
{
"path": "npm/win32-ia32/package.json",
"chars": 882,
"preview": "{\n \"name\": \"@img/sharp-win32-ia32\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with Windows x86 (3"
},
{
"path": "npm/win32-x64/package.json",
"chars": 869,
"preview": "{\n \"name\": \"@img/sharp-win32-x64\",\n \"version\": \"0.34.5\",\n \"description\": \"Prebuilt sharp for use with Windows x64\",\n "
},
{
"path": "package.json",
"chars": 7470,
"preview": "{\n \"name\": \"sharp\",\n \"description\": \"High performance Node.js image processing, the fastest module to resize JPEG, PNG"
},
{
"path": "src/CPPLINT.cfg",
"chars": 181,
"preview": "set noparent\n\nlinelength=120\n\nfilter=-build/include\nfilter=+build/include_alpha\nfilter=+build/include_subdir\nfilter=+bui"
},
{
"path": "src/binding.gyp",
"chars": 10596,
"preview": "# Copyright 2013 Lovell Fuller and others.\n# SPDX-License-Identifier: Apache-2.0\n\n{\n 'variables': {\n 'vips_version':"
},
{
"path": "src/common.cc",
"chars": 39181,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n#include <algorithm>\n#include <"
},
{
"path": "src/common.h",
"chars": 10639,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n#ifndef SRC_COMMON_H_\n#define S"
},
{
"path": "src/emscripten/common.gypi",
"chars": 926,
"preview": "# Copyright 2013 Lovell Fuller and others.\n# SPDX-License-Identifier: Apache-2.0\n\n{\n 'variables': {\n 'OS': 'emscript"
},
{
"path": "src/emscripten/pre.js",
"chars": 483,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n/* global Module, ENV, _vips_sh"
},
{
"path": "src/metadata.cc",
"chars": 13221,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n#include <cmath>\n#include <nume"
},
{
"path": "src/metadata.h",
"chars": 1768,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n#ifndef SRC_METADATA_H_\n#define"
},
{
"path": "src/operations.cc",
"chars": 16584,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n#include <algorithm>\n#include <"
},
{
"path": "src/operations.h",
"chars": 3607,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n#ifndef SRC_OPERATIONS_H_\n#defi"
},
{
"path": "src/pipeline.cc",
"chars": 84430,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n#include <algorithm>\n#include <"
},
{
"path": "src/pipeline.h",
"chars": 9828,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n#ifndef SRC_PIPELINE_H_\n#define"
},
{
"path": "src/sharp.cc",
"chars": 1529,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n#include <mutex>\n\n#include <nap"
},
{
"path": "src/stats.cc",
"chars": 6683,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n#include <iostream>\n#include <n"
},
{
"path": "src/stats.h",
"chars": 1267,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n#ifndef SRC_STATS_H_\n#define SR"
},
{
"path": "src/utilities.cc",
"chars": 9454,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n#include <cmath>\n#include <cstd"
},
{
"path": "src/utilities.h",
"chars": 741,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\n#ifndef SRC_UTILITIES_H_\n#defin"
},
{
"path": "test/bench/Dockerfile",
"chars": 796,
"preview": "FROM ubuntu:25.04\nARG BRANCH=main\n\n# Install basic dependencies\nRUN apt-get -y update && apt-get install -y build-essent"
},
{
"path": "test/bench/package.json",
"chars": 520,
"preview": "{\n \"name\": \"sharp-benchmark\",\n \"version\": \"0.0.1\",\n \"private\": true,\n \"author\": \"Lovell Fuller <npm@lovell.info>\",\n "
},
{
"path": "test/bench/parallel.js",
"chars": 1107,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nprocess.env.UV_THREADPOOL_SIZE "
},
{
"path": "test/bench/perf.js",
"chars": 24216,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst fs = require('node:fs');\n"
},
{
"path": "test/bench/random.js",
"chars": 1825,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst imagemagick = require('im"
},
{
"path": "test/bench/run-with-docker.sh",
"chars": 304,
"preview": "#!/usr/bin/env bash\nset -e\n\nif ! type docker >/dev/null; then\n echo \"Please install docker\"\n exit 1\nfi\n\nBRANCH=$(git b"
},
{
"path": "test/fixtures/index.js",
"chars": 12744,
"preview": "/*!\n Copyright 2013 Lovell Fuller and others.\n SPDX-License-Identifier: Apache-2.0\n*/\n\nconst path = require('node:path"
},
{
"path": "test/leak/leak.sh",
"chars": 716,
"preview": "#!/usr/bin/env bash\nset -e\n\nif ! type valgrind >/dev/null; then\n echo \"Please install valgrind before running memory le"
}
]
// ... and 78 more files (download for full content)
About this extraction
This page contains the full source code of the lovell/sharp GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 278 files (1.3 MB), approximately 381.0k tokens, and a symbol index with 304 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.