Prerelease v0.34.2-rc.0

This also ensures we handle scRGB correctly, see:
e9c5a31552

.circleci/config.yml

@@ -0,0 +1,105 @@
+version: 2.1
+
+workflows:
+  build:
+    jobs:
+      - linux-arm64-glibc-node-18:
+          filters:
+            tags:
+              only: /^v.*/
+      - linux-arm64-musl-node-18:
+          filters:
+            tags:
+              only: /^v.*/
+      - linux-arm64-glibc-node-20:
+          filters:
+            tags:
+              only: /^v.*/
+      - linux-arm64-musl-node-20:
+          filters:
+            tags:
+              only: /^v.*/
+
+jobs:
+  linux-arm64-glibc-node-18:
+    resource_class: arm.medium
+    machine:
+      image: ubuntu-2204:current
+    steps:
+      - checkout
+      - run: |
+          sudo docker run -dit --name sharp --volume "${PWD}:/mnt/sharp" --workdir /mnt/sharp arm64v8/debian:bullseye
+          sudo docker exec sharp sh -c "apt-get update && apt-get install -y build-essential git python3 curl fonts-noto-core"
+          sudo docker exec sharp sh -c "mkdir -p /etc/apt/keyrings"
+          sudo docker exec sharp sh -c "curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg"
+          sudo docker exec sharp sh -c "echo 'deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_18.x nodistro main' | tee /etc/apt/sources.list.d/nodesource.list"
+          sudo docker exec sharp sh -c "apt-get update && apt-get install -y nodejs"
+      - run: sudo docker exec sharp sh -c "npm install --build-from-source"
+      - run: sudo docker exec sharp sh -c "npm test"
+      - run: |
+          sudo docker exec sharp sh -c "npm run package-from-local-build"
+          sudo docker exec sharp sh -c "npm pkg set \"optionalDependencies.@img/sharp-linux-arm64=file:./npm/linux-arm64\""
+          sudo docker exec sharp sh -c "npm run clean"
+          sudo docker exec sharp sh -c "npm install --ignore-scripts"
+          sudo docker exec sharp sh -c "npm test"
+      - run: "[[ -n $CIRCLE_TAG ]] && sudo docker exec --env prebuild_upload sharp sh -c \"cd src && ln -s ../package.json && npx prebuild --upload=$prebuild_upload\" || true"
+  linux-arm64-glibc-node-20:
+    resource_class: arm.medium
+    machine:
+      image: ubuntu-2204:current
+    steps:
+      - checkout
+      - run: |
+          sudo docker run -dit --name sharp --workdir /mnt/sharp arm64v8/debian:bullseye
+          sudo docker exec sharp sh -c "apt-get update && apt-get install -y build-essential git python3 curl fonts-noto-core"
+          sudo docker exec sharp sh -c "mkdir -p /etc/apt/keyrings"
+          sudo docker exec sharp sh -c "curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg"
+          sudo docker exec sharp sh -c "echo 'deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_20.x nodistro main' | tee /etc/apt/sources.list.d/nodesource.list"
+          sudo docker exec sharp sh -c "apt-get update && apt-get install -y nodejs"
+          sudo docker exec sharp sh -c "mkdir -p /mnt/sharp"
+          sudo docker cp . sharp:/mnt/sharp/.
+      - run: sudo docker exec sharp sh -c "npm install --build-from-source"
+      - run: sudo docker exec sharp sh -c "npm test"
+      - run: |
+          sudo docker exec sharp sh -c "npm run package-from-local-build"
+          sudo docker exec sharp sh -c "npm pkg set \"optionalDependencies.@img/sharp-linux-arm64=file:./npm/linux-arm64\""
+          sudo docker exec sharp sh -c "npm run clean"
+          sudo docker exec sharp sh -c "npm install --ignore-scripts"
+          sudo docker exec sharp sh -c "npm test"
+  linux-arm64-musl-node-18:
+    resource_class: arm.medium
+    machine:
+      image: ubuntu-2204:current
+    steps:
+      - checkout
+      - run: |
+          sudo docker run -dit --name sharp --volume "${PWD}:/mnt/sharp" --workdir /mnt/sharp node:18-alpine3.17
+          sudo docker exec sharp sh -c "apk add build-base git python3 font-noto --update-cache"
+      - run: sudo docker exec sharp sh -c "npm install --build-from-source"
+      - run: sudo docker exec sharp sh -c "npm test"
+      - run: |
+          sudo docker exec sharp sh -c "npm run package-from-local-build"
+          sudo docker exec sharp sh -c "npm pkg set \"optionalDependencies.@img/sharp-linuxmusl-arm64=file:./npm/linuxmusl-arm64\""
+          sudo docker exec sharp sh -c "npm run clean"
+          sudo docker exec sharp sh -c "npm install --ignore-scripts"
+          sudo docker exec sharp sh -c "npm test"
+      - run: "[[ -n $CIRCLE_TAG ]] && sudo docker exec --env prebuild_upload sharp sh -c \"cd src && ln -s ../package.json && npx prebuild --upload=$prebuild_upload\" || true"
+  linux-arm64-musl-node-20:
+    resource_class: arm.medium
+    machine:
+      image: ubuntu-2204:current
+    steps:
+      - checkout
+      - run: |
+          sudo docker run -dit --name sharp --workdir /mnt/sharp node:20-alpine3.18
+          sudo docker exec sharp sh -c "apk add build-base git python3 font-noto --update-cache"
+          sudo docker exec sharp sh -c "mkdir -p /mnt/sharp"
+          sudo docker cp . sharp:/mnt/sharp/.
+      - run: sudo docker exec sharp sh -c "npm install --build-from-source"
+      - run: sudo docker exec sharp sh -c "npm test"
+      - run: |
+          sudo docker exec sharp sh -c "npm run package-from-local-build"
+          sudo docker exec sharp sh -c "npm pkg set \"optionalDependencies.@img/sharp-linuxmusl-arm64=file:./npm/linuxmusl-arm64\""
+          sudo docker exec sharp sh -c "npm run clean"
+          sudo docker exec sharp sh -c "npm install --ignore-scripts"
+          sudo docker exec sharp sh -c "npm test"

.cirrus.yml

@@ -0,0 +1,17 @@
+freebsd_instance:
+  image_family: freebsd-14-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/node20 www/npm
+    - pkg-config --modversion vips-cpp
+  install_script:
+    - npm install --build-from-source
+  test_script:
+    - npx mocha --no-config --spec=test/unit/io.js --timeout=30000

.github/CONTRIBUTING.md

@@ -12,47 +12,46 @@ 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.
+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](http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/ch03.html) the feature you need.
+Implementation is usually straightforward if libvips
+[already supports](https://www.libvips.org/API/current/func-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 `master` branch as the destination for your Pull Request so your fix can be included in the next minor release.
+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/master`.
+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 install` and then run the tests using `npm test`.
+To test C++ changes, you can compile the module using `npm install --build-from-source` 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/master/test/unit) to cover your new feature.
+Please add JavaScript [unit tests](https://github.com/lovell/sharp/tree/main/test/unit) to cover your new feature.
 A test coverage report for the JavaScript code is generated in the `coverage/lcov-report` directory.
+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/master/package.json#L5).
+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.
 
-| Release | WIP branch |
-| ------: | :--------- |
-| v0.18.0 | ridge      |
-| v0.19.0 | suit       |
-
 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_.
+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. Methods with mandatory parameters often have names like `doSomethingWith(X)`.
-
-Please ensure backwards compatibility where possible. Methods to modify previously default behaviour often have names like `withoutOptionY()` or `withExtraZ()`.
+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.
 
@@ -60,15 +59,15 @@ Feel free to create a [new issue](https://github.com/lovell/sharp/issues/new) to
 
 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 [bilinearInterpolation method](https://github.com/lovell/sharp/blob/v0.6.0/index.js#L155) present in v0.5.0 was deprecated in v0.6.0 and removed in v0.7.0.
+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](http://usejsdoc.org/) annotated comments.
+The public API is documented with [JSDoc](https://jsdoc.app/) annotated comments.
 
 These can be converted to Markdown by running:
 ```sh
-npm run docs
+npm run docs-build
 ```
 
 Please include documentation updates in any Pull Request that modifies the public API.
@@ -89,20 +88,11 @@ Requires [Valgrind](http://valgrind.org/).
 npm run test-leak
 ```
 
-### Packaging tests
-
-Tests the installation on a number of Linux-based operating systems.
-Requires docker.
-
-```sh
-npm run test-packaging
-```
-
 ## 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/master/package.json#L4)
+[e-mail](https://github.com/lovell/sharp/blob/main/package.json#L5)
 for private, paid consulting.

.github/FUNDING.yml

@@ -0,0 +1 @@
+open_collective: libvips

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Documentation
+    url: https://sharp.pixelplumbing.com/
+    about: Installation instructions, complete API documentation with examples, changelog

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,28 @@
+---
+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. -->

.github/ISSUE_TEMPLATE/installation.md

@@ -0,0 +1,69 @@
+---
+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. -->

.github/ISSUE_TEMPLATE/possible-bug.md

@@ -0,0 +1,65 @@
+---
+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. -->

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,26 @@
+---
+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. -->

.github/SECURITY.md

@@ -0,0 +1,18 @@
+# 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.

.github/workflows/ci.yml

@@ -0,0 +1,256 @@
+name: CI
+on:
+  - push
+  - pull_request
+permissions: {}
+jobs:
+  github-runner:
+    permissions:
+      contents: write
+    name: ${{ matrix.platform }} - Node.js ${{ matrix.nodejs_version_major }} ${{ matrix.prebuild && '- prebuild' }}
+    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
+            prebuild: 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
+            prebuild: 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: macos-13
+            nodejs_arch: x64
+            nodejs_version: "^18.17.0"
+            nodejs_version_major: 18
+            platform: darwin-x64
+            prebuild: true
+          - os: macos-13
+            nodejs_arch: x64
+            nodejs_version: "^20.3.0"
+            nodejs_version_major: 20
+            platform: darwin-x64
+          - os: macos-13
+            nodejs_arch: x64
+            nodejs_version: "^22.9.0"
+            nodejs_version_major: 22
+            platform: darwin-x64
+          - os: macos-14
+            nodejs_arch: arm64
+            nodejs_version: "^18.17.0"
+            nodejs_version_major: 18
+            platform: darwin-arm64
+            prebuild: true
+          - os: macos-14
+            nodejs_arch: arm64
+            nodejs_version: "^20.3.0"
+            nodejs_version_major: 20
+            platform: darwin-arm64
+          - os: macos-14
+            nodejs_arch: arm64
+            nodejs_version: "^22.9.0"
+            nodejs_version_major: 22
+            platform: darwin-arm64
+          - os: windows-2019
+            nodejs_arch: x86
+            nodejs_version: "18.18.2" # pinned to avoid 18.19.0 and npm 10
+            nodejs_version_major: 18
+            platform: win32-ia32
+            prebuild: true
+          - os: windows-2019
+            nodejs_arch: x86
+            nodejs_version: "^20.3.0"
+            nodejs_version_major: 20
+            platform: win32-ia32
+          - os: windows-2019
+            nodejs_arch: x86
+            nodejs_version: "^22.9.0"
+            nodejs_version_major: 22
+            platform: win32-ia32
+          - os: windows-2019
+            nodejs_arch: x64
+            nodejs_version: "^18.17.0"
+            nodejs_version_major: 18
+            platform: win32-x64
+            prebuild: true
+          - os: windows-2019
+            nodejs_arch: x64
+            nodejs_version: "^20.3.0"
+            nodejs_version_major: 20
+            platform: win32-x64
+          - os: windows-2019
+            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
+            prebuild: 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-11-gcc-c++ make git python3.12 fontconfig google-noto-sans-fonts
+          echo "/opt/rh/gcc-toolset-11/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@v4
+        with:
+          node-version: ${{ matrix.nodejs_version }}
+          architecture: ${{ matrix.nodejs_arch }}
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install
+        run: npm install --build-from-source
+      - name: Test
+        run: npm test
+      - name: Test packaging
+        run: |
+          npm run package-from-local-build
+          npm pkg set "optionalDependencies.@img/sharp-${{ matrix.platform }}=file:./npm/${{ matrix.platform }}"
+          npm run clean
+          npm install --ignore-scripts
+          npm test
+      - name: Prebuild
+        if: matrix.prebuild && startsWith(github.ref, 'refs/tags/')
+        env:
+          prebuild_upload: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          node -e "require('fs').cpSync('package.json', 'src/package.json')"
+          cd src
+          npx prebuild
+  github-runner-qemu:
+    permissions:
+      contents: write
+    name: ${{ matrix.platform }} - Node.js ${{ matrix.nodejs_version_major }} - prebuild
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: linux-arm
+            distro: bullseye
+            run_on_arch: armv6
+            nodejs_arch: armv6l
+            nodejs_hostname: unofficial-builds.nodejs.org
+            nodejs_version: "18.17.0"
+            nodejs_version_major: 18
+          - platform: linux-s390x
+            distro: bullseye
+            run_on_arch: s390x
+            nodejs_arch: s390x
+            nodejs_hostname: nodejs.org
+            nodejs_version: "18.17.0"
+            nodejs_version_major: 18
+          - platform: linux-ppc64
+            distro: bullseye
+            run_on_arch: ppc64le
+            nodejs_arch: ppc64le
+            nodejs_hostname: nodejs.org
+            nodejs_version: "18.17.0"
+            nodejs_version_major: 18
+    steps:
+      - uses: actions/checkout@v4
+      - uses: uraimo/run-on-arch-action@v3
+        with:
+          arch: ${{ matrix.run_on_arch }}
+          distro: ${{ matrix.distro }}
+          env: |
+            prebuild_upload: "${{ startsWith(github.ref, 'refs/tags/') && secrets.GITHUB_TOKEN || '' }}"
+          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 --build-from-source
+            npx mocha --no-config --spec=test/unit/io.js --timeout=30000
+            npm run package-from-local-build
+            npm pkg set "optionalDependencies.@img/sharp-${{ matrix.platform }}=file:./npm/${{ matrix.platform }}"
+            npm run clean
+            npm install --ignore-scripts
+            npx mocha --no-config --spec=test/unit/io.js --timeout=30000
+            [[ -n $prebuild_upload ]] && cd src && ln -s ../package.json && npx prebuild || true
+  github-runner-emscripten:
+    permissions:
+      contents: write
+    name: wasm32 - prebuild
+    runs-on: ubuntu-24.04
+    container: "emscripten/emsdk:4.0.6"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Dependencies
+        run: apt-get update && apt-get install -y pkg-config
+      - name: Dependencies (Node.js)
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+      - name: Install
+        run: emmake npm install --build-from-source
+      - 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"
+      - name: Test
+        run: emmake npm test
+      - name: Test packaging
+        run: |
+          emmake npm run package-from-local-build
+          npm pkg set "optionalDependencies.@img/sharp-wasm32=file:./npm/wasm32"
+          npm run clean
+          rm -rf node_modules/@img/sharp-linux-x64
+          npm install --cpu=wasm32
+          npm test
+      - name: Prebuild
+        if: startsWith(github.ref, 'refs/tags/')
+        env:
+          npm_config_nodedir: emscripten
+          prebuild_upload: ${{ secrets.GITHUB_TOKEN }}
+        run: cd src && ln -s ../package.json && emmake npx prebuild --platform=emscripten --arch=wasm32 --strip=0

.github/workflows/npm.yml

@@ -0,0 +1,194 @@
+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-13
+            runtime: node
+            package-manager: npm
+          - name: darwin-x64-node-pnpm
+            runs-on: macos-13
+            runtime: node
+            package-manager: pnpm
+          - name: darwin-x64-node-yarn
+            runs-on: macos-13
+            runtime: node
+            package-manager: yarn
+          - name: darwin-x64-node-yarn-pnp
+            runs-on: macos-13
+            runtime: node
+            package-manager: yarn-pnp
+          - name: darwin-x64-node-yarn-v1
+            runs-on: macos-13
+            runtime: node
+            package-manager: yarn-v1
+          - name: darwin-x64-deno
+            runs-on: macos-13
+            runtime: deno
+          - name: darwin-x64-bun
+            runs-on: macos-13
+            runtime: bun
+
+          - name: win32-x64-node-npm
+            runs-on: windows-2019
+            runtime: node
+            package-manager: npm
+          - name: win32-x64-node-pnpm
+            runs-on: windows-2019
+            runtime: node
+            package-manager: pnpm
+          - name: win32-x64-node-yarn
+            runs-on: windows-2019
+            runtime: node
+            package-manager: yarn
+          - name: win32-x64-node-yarn-pnp
+            runs-on: windows-2019
+            runtime: node
+            package-manager: yarn-pnp
+          - name: win32-x64-node-yarn-v1
+            runs-on: windows-2019
+            runtime: node
+            package-manager: yarn-v1
+          - name: win32-x64-deno
+            runs-on: windows-2019
+            runtime: deno
+
+    steps:
+      - name: Install Node.js
+        if: ${{ matrix.runtime == 'node' }}
+        uses: actions/setup-node@v4
+        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@v1
+        with:
+          deno-version: v1.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@v7
+        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 run --allow-read --allow-ffi release.mjs
+
+      - name: Run with Bun
+        if: ${{ matrix.runtime == 'bun' }}
+        run: |
+          bun install --ignore-scripts
+          bun release.mjs

.gitignore

@@ -1,16 +1,18 @@
-build
+src/build
+src/node_modules
 node_modules
-coverage
+/coverage
+npm/*/*
+!npm/*/package.json
 test/bench/node_modules
 test/fixtures/output*
+test/fixtures/vips-properties.xml
 test/leak/libvips.supp
-test/saliency/report.json
-test/saliency/Image*
-test/saliency/[Uu]serData*
-!test/saliency/userData.js
-vendor
-packaging/libvips*
-packaging/*.log
-!packaging/build
 .DS_Store
 .nyc_output
+.vscode/
+package-lock.json
+.idea
+.firebase
+.astro
+docs/dist

.mocharc.jsonc

@@ -0,0 +1,7 @@
+{
+  "parallel": true,
+  "slow": 1000,
+  "timeout": 30000,
+  "require": "./test/beforeEach.js",
+  "spec": "./test/unit/*.js"
+}

.npmignore

@@ -1,14 +0,0 @@
-build
-node_modules
-coverage
-.editorconfig
-.gitignore
-test
-.travis.yml
-appveyor.yml
-circle.yml
-mkdocs.yml
-vendor
-packaging
-preinstall.sh
-.nyc_output

.prebuildrc

@@ -0,0 +1,6 @@
+{
+  "runtime": "napi",
+  "include-regex": "(sharp-.+\\.node|libvips-.+\\.dll)",
+  "prerelease": true,
+  "strip": true
+}

.travis.yml

@@ -1,27 +0,0 @@
-language: node_js
-matrix:
-  include:
-    - os: linux
-      dist: trusty
-      sudo: false
-      node_js: "4"
-    - os: linux
-      dist: trusty
-      sudo: false
-      node_js: "6"
-    - os: linux
-      dist: trusty
-      sudo: false
-      node_js: "8"
-    - os: osx
-      osx_image: xcode8
-      node_js: "4"
-    - os: osx
-      osx_image: xcode8
-      node_js: "6"
-    - os: osx
-      osx_image: xcode8
-      node_js: "8"
-after_success:
-  - npm install coveralls
-  - cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js

README.md

@@ -1,15 +1,18 @@
 # sharp
 
-```sh
-npm install 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.js module
+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 and WebP images of varying dimensions.
+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.
+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.
@@ -17,39 +20,76 @@ 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.
 
-OS X, Windows (x64), Linux (x64, ARM) systems do not require
-the installation of any external runtime dependencies.
+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
 
-```javascript
-import sharp from 'sharp';
+```sh
+npm install sharp
 ```
 
+```javascript
+const sharp = require('sharp');
+```
+
+### Callback
+
 ```javascript
 sharp(inputBuffer)
   .resize(320, 240)
-  .toFile('output.webp', (err, info) => ... );
+  .toFile('output.webp', (err, info) => { ... });
 ```
 
+### Promise
+
 ```javascript
 sharp('input.jpg')
   .rotate()
   .resize(200)
+  .jpeg({ mozjpeg: true })
   .toBuffer()
-  .then( data => ... )
-  .catch( err => ... );
+  .then( data => { ... })
+  .catch( err => { ... });
 ```
 
+### Async/await
+
 ```javascript
-const roundedCorners = new Buffer(
+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)
-    .overlayWith(roundedCorners, { cutout: true })
+    .composite([{
+      input: roundedCorners,
+      blend: 'dest-in'
+    }])
     .png();
 
 readableStream
@@ -57,29 +97,19 @@ readableStream
   .pipe(writableStream);
 ```
 
-[![Test Coverage](https://coveralls.io/repos/lovell/sharp/badge.png?branch=master)](https://coveralls.io/r/lovell/sharp?branch=master)
+## Contributing
 
-### Documentation
-
-Visit [sharp.dimens.io](http://sharp.dimens.io/) for complete
-[installation instructions](http://sharp.dimens.io/page/install),
-[API documentation](http://sharp.dimens.io/page/api),
-[benchmark tests](http://sharp.dimens.io/page/performance) and
-[changelog](http://sharp.dimens.io/page/changelog).
-
-### Contributing
-
-A [guide for contributors](https://github.com/lovell/sharp/blob/master/CONTRIBUTING.md)
+A [guide for contributors](https://github.com/lovell/sharp/blob/main/.github/CONTRIBUTING.md)
 covers reporting bugs, requesting features and submitting code changes.
 
-### Licence
+## Licensing
 
-Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+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
-[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
+[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,

appveyor.yml

@@ -1,15 +0,0 @@
-os: Visual Studio 2015
-version: "{build}"
-build: off
-platform: x64
-environment:
-  matrix:
-  - nodejs_version: "4"
-  - nodejs_version: "6"
-  - nodejs_version: "7"
-install:
-  - ps: Install-Product node $env:nodejs_version x64
-  - npm install -g npm@latest
-  - npm install
-test_script:
-  - npm test

binding.gyp

@@ -1,278 +0,0 @@
-{
-  'targets': [{
-    'target_name': 'libvips-cpp',
-    'conditions': [
-      ['OS == "win"', {
-        # Build libvips C++ binding for Windows due to MSVC std library ABI changes
-        'type': 'shared_library',
-        'variables': {
-          'download_vips': '<!(node -e "require(\'./binding\').download_vips()")'
-        },
-        'defines': [
-          'VIPS_CPLUSPLUS_EXPORTS',
-          '_ALLOW_KEYWORD_MACROS'
-        ],
-        'sources': [
-          'src/libvips/cplusplus/VError.cpp',
-          'src/libvips/cplusplus/VInterpolate.cpp',
-          'src/libvips/cplusplus/VImage.cpp'
-        ],
-        'include_dirs': [
-          'vendor/include',
-          'vendor/include/glib-2.0',
-          'vendor/lib/glib-2.0/include'
-        ],
-        'libraries': [
-          '../vendor/lib/libvips.lib',
-          '../vendor/lib/libglib-2.0.lib',
-          '../vendor/lib/libgobject-2.0.lib'
-        ],
-        'configurations': {
-          'Release': {
-            'msvs_settings': {
-              'VCCLCompilerTool': {
-                'ExceptionHandling': 1
-              }
-            },
-            'msvs_disabled_warnings': [
-              4275
-            ]
-          }
-        }
-      }, {
-        # Ignore this target for non-Windows
-        'type': 'none'
-      }]
-    ]
-  }, {
-    'target_name': 'sharp',
-    'dependencies': [
-      'libvips-cpp'
-    ],
-    # Nested variables "pattern" borrowed from http://src.chromium.org/viewvc/chrome/trunk/src/build/common.gypi
-    'variables': {
-      'variables': {
-        'variables': {
-          'conditions': [
-            ['OS != "win"', {
-              # Build the PKG_CONFIG_PATH environment variable with all possible combinations
-              'pkg_config_path': '<!(which brew >/dev/null 2>&1 && eval $(brew --env) && echo $PKG_CONFIG_LIBDIR || true):$PKG_CONFIG_PATH:/usr/local/lib/pkgconfig:/usr/lib/pkgconfig'
-            }, {
-              'pkg_config_path': ''
-            }]
-          ],
-        },
-        'conditions': [
-          ['OS != "win"', {
-            # Which version, if any, of libvips is available globally via pkg-config?
-            'global_vips_version': '<!(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --modversion vips-cpp 2>/dev/null || true)'
-          }, {
-            'global_vips_version': ''
-          }]
-        ],
-        'pkg_config_path%': '<(pkg_config_path)'
-      },
-      'pkg_config_path%': '<(pkg_config_path)',
-      'runtime_link%': 'shared',
-      'conditions': [
-        ['OS != "win"', {
-          # Does the globally available version of libvips, if any, meet the minimum version requirement?
-          'use_global_vips': '<!(GLOBAL_VIPS_VERSION="<(global_vips_version)" node -e "require(\'./binding\').use_global_vips()")'
-        }, {
-          'use_global_vips': ''
-        }]
-      ]
-    },
-    'sources': [
-      'src/common.cc',
-      'src/metadata.cc',
-      'src/operations.cc',
-      'src/pipeline.cc',
-      'src/sharp.cc',
-      'src/utilities.cc'
-    ],
-    'include_dirs': [
-      '<!(node -e "require(\'nan\')")'
-    ],
-    'conditions': [
-      ['use_global_vips == "true"', {
-        # Use pkg-config for include and lib
-        'include_dirs': ['<!@(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --cflags-only-I vips-cpp vips glib-2.0 | sed s\/-I//g)'],
-        'conditions': [
-          ['runtime_link == "static"', {
-            'libraries': ['<!@(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --libs --static vips-cpp)']
-          }, {
-            'libraries': ['<!@(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --libs vips-cpp)']
-          }],
-          ['OS == "linux"', {
-            'defines': [
-              # Inspect libvips-cpp.so to determine which C++11 ABI version was used and set _GLIBCXX_USE_CXX11_ABI accordingly. This is quite horrible.
-              '_GLIBCXX_USE_CXX11_ABI=<!(if readelf -Ws "$(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --variable libdir vips-cpp)/libvips-cpp.so" | c++filt | grep -qF __cxx11;then echo "1";else echo "0";fi)'
-            ]
-          }]
-        ]
-      }, {
-        # Attempt to download pre-built libvips and install locally within node_modules
-        'include_dirs': [
-          'vendor/include',
-          'vendor/include/glib-2.0',
-          'vendor/lib/glib-2.0/include'
-        ],
-        'conditions': [
-          ['OS == "win"', {
-            'defines': [
-              '_ALLOW_KEYWORD_MACROS'
-            ],
-            'libraries': [
-              '../vendor/lib/libvips.lib',
-              '../vendor/lib/libglib-2.0.lib',
-              '../vendor/lib/libgobject-2.0.lib'
-            ]
-          }],
-          ['OS == "mac"', {
-            'variables': {
-              'download_vips': '<!(node -e "require(\'./binding\').download_vips()")'
-            },
-            'libraries': [
-              '../vendor/lib/libvips-cpp.42.dylib',
-              '../vendor/lib/libvips.42.dylib',
-              '../vendor/lib/libglib-2.0.0.dylib',
-              '../vendor/lib/libgobject-2.0.0.dylib',
-              # Ensure runtime linking is relative to sharp.node
-              '-rpath \'@loader_path/../../vendor/lib\''
-            ]
-          }],
-          ['OS == "linux"', {
-            'variables': {
-              'download_vips': '<!(LDD_VERSION="<!(ldd --version 2>&1 || true)" node -e "require(\'./binding\').download_vips()")'
-            },
-            'defines': [
-              '_GLIBCXX_USE_CXX11_ABI=0'
-            ],
-            'libraries': [
-              '../vendor/lib/libvips-cpp.so',
-              '../vendor/lib/libvips.so',
-              '../vendor/lib/libglib-2.0.so',
-              '../vendor/lib/libgobject-2.0.so',
-              # Dependencies of dependencies, included for openSUSE support
-              '../vendor/lib/libcairo.so',
-              '../vendor/lib/libcroco-0.6.so',
-              '../vendor/lib/libexif.so',
-              '../vendor/lib/libffi.so',
-              '../vendor/lib/libfontconfig.so',
-              '../vendor/lib/libfreetype.so',
-              '../vendor/lib/libgdk_pixbuf-2.0.so',
-              '../vendor/lib/libgif.so',
-              '../vendor/lib/libgio-2.0.so',
-              '../vendor/lib/libgmodule-2.0.so',
-              '../vendor/lib/libgsf-1.so',
-              '../vendor/lib/libgthread-2.0.so',
-              '../vendor/lib/libharfbuzz.so',
-              '../vendor/lib/libjpeg.so',
-              '../vendor/lib/liblcms2.so',
-              '../vendor/lib/liborc-0.4.so',
-              '../vendor/lib/libpango-1.0.so',
-              '../vendor/lib/libpangocairo-1.0.so',
-              '../vendor/lib/libpangoft2-1.0.so',
-              '../vendor/lib/libpixman-1.so',
-              '../vendor/lib/libpng.so',
-              '../vendor/lib/librsvg-2.so',
-              '../vendor/lib/libtiff.so',
-              '../vendor/lib/libwebp.so',
-              '../vendor/lib/libxml2.so',
-              '../vendor/lib/libz.so',
-              # Ensure runtime linking is relative to sharp.node
-              '-Wl,--disable-new-dtags -Wl,-rpath=\'$${ORIGIN}/../../vendor/lib\''
-            ]
-          }]
-        ]
-      }]
-    ],
-    'cflags_cc': [
-      '-std=c++0x',
-      '-fexceptions',
-      '-Wall',
-      '-O3'
-    ],
-    'xcode_settings': {
-      'CLANG_CXX_LANGUAGE_STANDARD': 'c++11',
-      'CLANG_CXX_LIBRARY': 'libc++',
-      'MACOSX_DEPLOYMENT_TARGET': '10.7',
-      'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
-      'GCC_ENABLE_CPP_RTTI': 'YES',
-      'OTHER_CPLUSPLUSFLAGS': [
-        '-fexceptions',
-        '-Wall',
-        '-O3'
-      ]
-    },
-    'configurations': {
-      'Release': {
-        'msvs_settings': {
-          'VCCLCompilerTool': {
-            'ExceptionHandling': 1
-          }
-        },
-        'msvs_disabled_warnings': [
-          4275
-        ]
-      }
-    },
-  }, {
-    'target_name': 'win_copy_dlls',
-    'type': 'none',
-    'dependencies': [
-      'sharp'
-    ],
-    'conditions': [
-      ['OS == "win"', {
-        # Windows lacks support for rpath
-        'copies': [{
-          'destination': 'build/Release',
-          'files': [
-            'vendor/lib/GNU.Gettext.dll',
-            'vendor/lib/libasprintf-0.dll',
-            'vendor/lib/libcairo-2.dll',
-            'vendor/lib/libcairo-gobject-2.dll',
-            'vendor/lib/libcairo-script-interpreter-2.dll',
-            'vendor/lib/libcharset-1.dll',
-            'vendor/lib/libcroco-0.6-3.dll',
-            'vendor/lib/libexif-12.dll',
-            'vendor/lib/libexpat-1.dll',
-            'vendor/lib/libffi-6.dll',
-            'vendor/lib/libfftw3-3.dll',
-            'vendor/lib/libfontconfig-1.dll',
-            'vendor/lib/libfreetype-6.dll',
-            'vendor/lib/libgcc_s_seh-1.dll',
-            'vendor/lib/libgdk_pixbuf-2.0-0.dll',
-            'vendor/lib/libgif-7.dll',
-            'vendor/lib/libgio-2.0-0.dll',
-            'vendor/lib/libglib-2.0-0.dll',
-            'vendor/lib/libgmodule-2.0-0.dll',
-            'vendor/lib/libgobject-2.0-0.dll',
-            'vendor/lib/libgsf-1-114.dll',
-            'vendor/lib/libgthread-2.0-0.dll',
-            'vendor/lib/libiconv-2.dll',
-            'vendor/lib/libintl-8.dll',
-            'vendor/lib/libjpeg-62.dll',
-            'vendor/lib/liblcms2-2.dll',
-            'vendor/lib/libpango-1.0-0.dll',
-            'vendor/lib/libpangocairo-1.0-0.dll',
-            'vendor/lib/libpangowin32-1.0-0.dll',
-            'vendor/lib/libpixman-1-0.dll',
-            'vendor/lib/libpng16-16.dll',
-            'vendor/lib/libquadmath-0.dll',
-            'vendor/lib/librsvg-2-2.dll',
-            'vendor/lib/libssp-0.dll',
-            'vendor/lib/libstdc++-6.dll',
-            'vendor/lib/libtiff-5.dll',
-            'vendor/lib/libvips-42.dll',
-            'vendor/lib/libwebp-7.dll',
-            'vendor/lib/libxml2-2.dll',
-            'vendor/lib/zlib1.dll'
-          ]
-        }]
-      }]
-    ]
-  }]
-}

binding.js

@@ -1,129 +0,0 @@
-'use strict';
-
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
-
-const caw = require('caw');
-const got = require('got');
-const semver = require('semver');
-const tar = require('tar');
-
-const distBaseUrl = 'https://dl.bintray.com/lovell/sharp/';
-
-// Use NPM-provided environment variable where available, falling back to require-based method for Electron
-const minimumLibvipsVersion = process.env.npm_package_config_libvips || require('./package.json').config.libvips;
-
-const platform = process.env.npm_config_platform || process.platform;
-
-const arch = process.env.npm_config_arch || process.arch;
-
-// -- Helpers
-
-// Does this file exist?
-const isFile = function (file) {
-  try {
-    return fs.statSync(file).isFile();
-  } catch (err) {}
-};
-
-const unpack = function (tarPath, done) {
-  const vendorPath = path.join(__dirname, 'vendor');
-  fs.mkdirSync(vendorPath);
-  tar
-    .extract({
-      file: tarPath,
-      cwd: vendorPath,
-      strict: true
-    })
-    .then(done)
-    .catch(error);
-};
-
-const platformId = function () {
-  const platformId = [platform];
-  if (arch === 'arm' || arch === 'armhf' || arch === 'arm64') {
-    const armVersion = (arch === 'arm64') ? '8' : process.env.npm_config_armv || process.config.variables.arm_version || '6';
-    platformId.push('armv' + armVersion);
-  } else {
-    platformId.push(arch);
-  }
-  return platformId.join('-');
-};
-
-// Error
-const error = function (msg) {
-  if (msg instanceof Error) {
-    msg = msg.message;
-  }
-  process.stderr.write('ERROR: ' + msg + '\n');
-  process.exit(1);
-};
-
-// -- Binary downloaders
-
-module.exports.download_vips = function () {
-  // Has vips been installed locally?
-  const vipsHeaderPath = path.join(__dirname, 'vendor', 'include', 'vips', 'vips.h');
-  if (!isFile(vipsHeaderPath)) {
-    // Ensure Intel 64-bit or ARM
-    if (arch === 'ia32') {
-      error('Intel Architecture 32-bit systems require manual installation - please see http://sharp.dimens.io/en/stable/install/');
-    }
-    // Ensure glibc >= 2.15
-    const lddVersion = process.env.LDD_VERSION;
-    if (lddVersion) {
-      if (/(glibc|gnu libc|gentoo)/i.test(lddVersion)) {
-        const glibcVersion = lddVersion ? lddVersion.split(/\n/)[0].split(' ').slice(-1)[0].trim() : '';
-        if (glibcVersion && semver.lt(glibcVersion + '.0', '2.13.0')) {
-          error('glibc version ' + glibcVersion + ' requires manual installation - please see http://sharp.dimens.io/en/stable/install/');
-        }
-      } else {
-        error(lddVersion.split(/\n/)[0] + ' requires manual installation - please see http://sharp.dimens.io/en/stable/install/');
-      }
-    }
-    // Arch/platform-specific .tar.gz
-    const tarFilename = ['libvips', minimumLibvipsVersion, platformId()].join('-') + '.tar.gz';
-    const tarPathLocal = path.join(__dirname, 'packaging', tarFilename);
-    if (isFile(tarPathLocal)) {
-      unpack(tarPathLocal);
-    } else {
-      // Download to per-process temporary file
-      const tarPathTemp = path.join(os.tmpdir(), process.pid + '-' + tarFilename);
-      const tmpFile = fs.createWriteStream(tarPathTemp).on('finish', function () {
-        unpack(tarPathTemp, function () {
-          // Attempt to remove temporary file
-          try {
-            fs.unlinkSync(tarPathTemp);
-          } catch (err) {}
-        });
-      });
-      const gotOpt = {
-        agent: caw(null, {
-          protocol: 'https'
-        })
-      };
-      const url = distBaseUrl + tarFilename;
-      got.stream(url, gotOpt).on('response', function (response) {
-        if (response.statusCode !== 200) {
-          error(url + ' status code ' + response.statusCode);
-        }
-      }).on('error', function (err) {
-        error('Download of ' + url + ' failed: ' + err.message);
-      }).pipe(tmpFile);
-    }
-  }
-};
-
-module.exports.use_global_vips = function () {
-  const globalVipsVersion = process.env.GLOBAL_VIPS_VERSION;
-  if (globalVipsVersion) {
-    const useGlobalVips = semver.gte(
-      globalVipsVersion,
-      minimumLibvipsVersion
-    );
-    process.stdout.write(useGlobalVips ? 'true' : 'false');
-  } else {
-    process.stdout.write('false');
-  }
-};

circle.yml

@@ -1,8 +0,0 @@
-machine:
-  node:
-    version: v4.6.1
-  services:
-    - docker
-test:
-  override:
-    - ./packaging/test-linux-x64.sh

docs/api-channel.md

@@ -1,77 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
-
--   [extractChannel](#extractchannel)
--   [joinChannel](#joinchannel)
--   [bandbool](#bandbool)
-
-## extractChannel
-
-Extract a single channel from a multi-channel image.
-
-**Parameters**
-
--   `channel` **([Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** zero-indexed band number to extract, or `red`, `green` or `blue` as alternative to `0`, `1` or `2` respectively.
-
-**Examples**
-
-```javascript
-sharp(input)
-  .extractChannel('green')
-  .toFile('input_green.jpg', function(err, info) {
-    // info.channels === 1
-    // input_green.jpg contains the green channel of the input image
-   });
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid channel
-
-Returns **Sharp** 
-
-## joinChannel
-
-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: JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data.
-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.
-
-**Parameters**
-
--   `images` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Buffer](https://nodejs.org/api/buffer.html))> | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Buffer](https://nodejs.org/api/buffer.html))** one or more images (file paths, Buffers).
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** image options, see `sharp()` constructor.
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## bandbool
-
-Perform a bitwise boolean operation on all input image channels (bands) to produce a single channel output image.
-
-**Parameters**
-
--   `boolOp` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
-
-**Examples**
-
-```javascript
-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`.
-  });
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 

docs/api-colour.md

@@ -1,79 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
-
--   [background](#background)
--   [greyscale](#greyscale)
--   [grayscale](#grayscale)
--   [toColourspace](#tocolourspace)
--   [toColorspace](#tocolorspace)
-
-## background
-
-Set the background for the `embed`, `flatten` and `extend` operations.
-The default background is `{r: 0, g: 0, b: 0, alpha: 1}`, black without transparency.
-
-Delegates to the _color_ module, which can throw an Error
-but is liberal in what it accepts, clipping values to sensible min/max.
-The alpha value is a float between `0` (transparent) and `1` (opaque).
-
-**Parameters**
-
--   `rgba` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameter
-
-Returns **Sharp** 
-
-## greyscale
-
-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) color channels.
-This may be overridden by other sharp operations such as `toColourspace('b-w')`,
-which will produce an output image containing one color channel.
-An alpha channel may be present, and will be unchanged by the operation.
-
-**Parameters**
-
--   `greyscale` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## grayscale
-
-Alternative spelling of `greyscale`.
-
-**Parameters**
-
--   `grayscale` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## toColourspace
-
-Set the output colourspace.
-By default output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.
-
-**Parameters**
-
--   `colourspace` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568)
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## toColorspace
-
-Alternative spelling of `toColourspace`.
-
-**Parameters**
-
--   `colorspace` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** output colorspace.
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 

docs/api-composite.md

@@ -1,59 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
-
--   [overlayWith](#overlaywith)
-
-## overlayWith
-
-Overlay (composite) an image over the processed (resized, extracted etc.) image.
-
-The overlay image must be the same size or smaller than the processed image.
-If both `top` and `left` options are provided, they take precedence over `gravity`.
-
-If the overlay image contains an alpha channel then composition with premultiplication will occur.
-
-**Parameters**
-
--   `overlay` **([Buffer](https://nodejs.org/api/buffer.html) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** Buffer containing image data or String containing the path to an image file.
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
-    -   `options.gravity` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** gravity at which to place the overlay. (optional, default `'centre'`)
-    -   `options.top` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the pixel offset from the top edge.
-    -   `options.left` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the pixel offset from the left edge.
-    -   `options.tile` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** set to true to repeat the overlay image across the entire image with the given `gravity`. (optional, default `false`)
-    -   `options.cutout` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** set to true to apply only the alpha channel of the overlay image to the input image, giving the appearance of one image being cut out of another. (optional, default `false`)
-    -   `options.density` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** integral number representing the DPI for vector overlay image. (optional, default `72`)
-    -   `options.raw` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes overlay when using raw pixel data.
-        -   `options.raw.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.raw.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.raw.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-    -   `options.create` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes a blank overlay to be created.
-        -   `options.create.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.create.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.create.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 3-4
-        -   `options.create.background` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
-
-**Examples**
-
-```javascript
-sharp('input.png')
-  .rotate(180)
-  .resize(300)
-  .flatten()
-  .background('#ff6600')
-  .overlayWith('overlay.png', { gravity: sharp.gravity.southeast } )
-  .sharpen()
-  .withMetadata()
-  .quality(90)
-  .webp()
-  .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!
-  });
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 

docs/api-constructor.md

@@ -1,108 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
-
--   [Sharp](#sharp)
-    -   [format](#format)
-    -   [versions](#versions)
--   [queue](#queue)
-
-## Sharp
-
-**Parameters**
-
--   `input` **([Buffer](https://nodejs.org/api/buffer.html) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))?** if present, can be
-     a Buffer containing JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data, or
-     a String containing the path to an JPEG, PNG, WebP, GIF, SVG or TIFF image file.
-     JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when not present.
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** if present, is an Object with optional attributes.
-    -   `options.density` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** integral number representing the DPI for vector images. (optional, default `72`)
-    -   `options.raw` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes raw pixel input image data. See `raw()` for pixel ordering.
-        -   `options.raw.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.raw.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.raw.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 1-4
-    -   `options.create` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes a new image to be created.
-        -   `options.create.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.create.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.create.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 3-4
-        -   `options.create.background` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
-
-**Examples**
-
-```javascript
-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
-  });
-```
-
-```javascript
-// Read image data from readableStream,
-// resize to 300 pixels wide,
-// emit an 'info' event with calculated dimensions
-// and finally write image data to writableStream
-var transformer = sharp()
-  .resize(300)
-  .on('info', function(info) {
-    console.log('Image height is ' + info.height);
-  });
-readableStream.pipe(transformer).pipe(writableStream);
-```
-
-```javascript
-// Create a blank 300x200 PNG image of semi-transluent red pixels
-sharp({
-  create: {
-    width: 300,
-    height: 200,
-    channels: 4,
-    background: { r: 255, g: 0, b: 0, alpha: 128 }
-  }
-})
-.png()
-.toBuffer()
-.then( ... );
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **[Sharp](#sharp)** 
-
-### format
-
-An Object containing nested boolean values representing the available input and output formats/methods.
-
-**Examples**
-
-```javascript
-console.log(sharp.format);
-```
-
-Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-
-### versions
-
-An Object containing the version numbers of libvips and its dependencies.
-
-**Examples**
-
-```javascript
-console.log(sharp.versions);
-```
-
-## queue
-
-An EventEmitter that emits a `change` event when a task is either:
-
--   queued, waiting for _libuv_ to provide a worker thread
--   complete
-
-**Examples**
-
-```javascript
-sharp.queue.on('change', function(queueLength) {
-  console.log('Queue contains ' + queueLength + ' task(s)');
-});
-```

docs/api-input.md

@@ -1,94 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
-
--   [clone](#clone)
--   [metadata](#metadata)
--   [limitInputPixels](#limitinputpixels)
--   [sequentialRead](#sequentialread)
-
-## clone
-
-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.
-
-**Examples**
-
-```javascript
-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
-```
-
-Returns **Sharp** 
-
-## metadata
-
-Fast access to (uncached) image metadata without decoding any compressed image data.
-A Promises/A+ promise is returned when `callback` is not provided.
-
--   `format`: Name of decoder used to decompress image data e.g. `jpeg`, `png`, `webp`, `gif`, `svg`
--   `width`: Number of pixels wide
--   `height`: Number of pixels high
--   `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L636)
--   `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://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L672)
--   `density`: Number of pixels per inch (DPI), 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
-
-**Parameters**
-
--   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)?** called with the arguments `(err, metadata)`
-
-**Examples**
-
-```javascript
-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
-  });
-```
-
-Returns **([Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)> | Sharp)** 
-
-## limitInputPixels
-
-Do not process input images where the number of pixels (width _ height) exceeds this limit.
-Assumes image dimensions contained in the input metadata can be trusted.
-The default limit is 268402689 (0x3FFF _ 0x3FFF) pixels.
-
-**Parameters**
-
--   `limit` **([Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean))** an integral Number of pixels, zero or false to remove limit, true to use default limit.
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid limit
-
-Returns **Sharp** 
-
-## sequentialRead
-
-An advanced setting that switches the libvips access method to `VIPS_ACCESS_SEQUENTIAL`.
-This will reduce memory usage and can improve performance on some systems.
-
-**Parameters**
-
--   `sequentialRead` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**  (optional, default `true`)
-
-Returns **Sharp** 

docs/api-operation.md

@@ -1,323 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
-
--   [rotate](#rotate)
--   [extract](#extract)
--   [flip](#flip)
--   [flop](#flop)
--   [sharpen](#sharpen)
--   [blur](#blur)
--   [extend](#extend)
--   [flatten](#flatten)
--   [trim](#trim)
--   [gamma](#gamma)
--   [negate](#negate)
--   [normalise](#normalise)
--   [normalize](#normalize)
--   [convolve](#convolve)
--   [threshold](#threshold)
--   [boolean](#boolean)
-
-## rotate
-
-Rotate the output image by either an explicit angle
-or auto-orient based on the EXIF `Orientation` tag.
-
-If an angle is provided, it is converted to a valid 90/180/270deg rotation.
-For example, `-450` will produce a 270deg rotation.
-
-If no angle is provided, it is determined from the EXIF data.
-Mirroring is supported and may infer the use of a flip operation.
-
-The use of `rotate` implies the removal of the EXIF `Orientation` tag, if any.
-
-Method order is important when both rotating and extracting regions,
-for example `rotate(x).extract(y)` will produce a different result to `extract(y).rotate(x)`.
-
-**Parameters**
-
--   `angle` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** angle of rotation, must be a multiple of 90. (optional, default `auto`)
-
-**Examples**
-
-```javascript
-const pipeline = sharp()
-  .rotate()
-  .resize(null, 200)
-  .toBuffer(function (err, outputBuffer, info) {
-    // outputBuffer contains 200px high JPEG image data,
-    // auto-rotated using EXIF Orientation tag
-    // info.width and info.height contain the dimensions of the resized image
-  });
-readableStream.pipe(pipeline);
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## extract
-
-Extract a region of the image.
-
--   Use `extract` before `resize` for pre-resize extraction.
--   Use `extract` after `resize` for post-resize extraction.
--   Use `extract` before and after for both.
-
-**Parameters**
-
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-    -   `options.left` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** zero-indexed offset from left edge
-    -   `options.top` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** zero-indexed offset from top edge
-    -   `options.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** dimension of extracted image
-    -   `options.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** dimension of extracted image
-
-**Examples**
-
-```javascript
-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.
-  });
-```
-
-```javascript
-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
-  });
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## flip
-
-Flip the image about the vertical Y axis. This always occurs after rotation, if any.
-The use of `flip` implies the removal of the EXIF `Orientation` tag, if any.
-
-**Parameters**
-
--   `flip` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## flop
-
-Flop the image about the horizontal X axis. This always occurs after rotation, if any.
-The use of `flop` implies the removal of the EXIF `Orientation` tag, if any.
-
-**Parameters**
-
--   `flop` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## sharpen
-
-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.
-Separate control over the level of sharpening in "flat" and "jagged" areas is available.
-
-**Parameters**
-
--   `sigma` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
--   `flat` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** the level of sharpening to apply to "flat" areas. (optional, default `1.0`)
--   `jagged` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** the level of sharpening to apply to "jagged" areas. (optional, default `2.0`)
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## blur
-
-Blur the image.
-When used without parameters, performs a fast, mild blur of the output image.
-When a `sigma` is provided, performs a slower, more accurate Gaussian blur.
-
-**Parameters**
-
--   `sigma` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** a value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## extend
-
-Extends/pads the edges of the image with the colour provided to the `background` method.
-This operation will always occur after resizing and extraction, if any.
-
-**Parameters**
-
--   `extend` **([Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** single pixel count to add to all edges or an Object with per-edge counts
-    -   `extend.top` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-    -   `extend.left` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-    -   `extend.bottom` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-    -   `extend.right` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-
-**Examples**
-
-```javascript
-// 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)
-  .background({r: 0, g: 0, b: 0, alpha: 0})
-  .extend({top: 10, bottom: 20, left: 10, right: 10})
-  ...
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## flatten
-
-Merge alpha transparency channel, if any, with `background`.
-
-**Parameters**
-
--   `flatten` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## trim
-
-Trim "boring" pixels from all edges that contain values within a percentage similarity of the top-left pixel.
-
-**Parameters**
-
--   `tolerance` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** value between 1 and 99 representing the percentage similarity. (optional, default `10`)
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## gamma
-
-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.
-
-**Parameters**
-
--   `gamma` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** value between 1.0 and 3.0. (optional, default `2.2`)
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## negate
-
-Produce the "negative" of the image.
-
-**Parameters**
-
--   `negate` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## normalise
-
-Enhance output image contrast by stretching its luminance to cover the full dynamic range.
-
-**Parameters**
-
--   `normalise` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## normalize
-
-Alternative spelling of normalise.
-
-**Parameters**
-
--   `normalize` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## convolve
-
-Convolve the image with the specified kernel.
-
-**Parameters**
-
--   `kernel` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-    -   `kernel.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** width of the kernel in pixels.
-    -   `kernel.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** width of the kernel in pixels.
-    -   `kernel.kernel` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** Array of length `width*height` containing the kernel values.
-    -   `kernel.scale` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** the scale of the kernel in pixels. (optional, default `sum`)
-    -   `kernel.offset` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** the offset of the kernel in pixels. (optional, default `0`)
-
-**Examples**
-
-```javascript
-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
-  });
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## threshold
-
-Any pixel value greather than or equal to the threshold value will be set to 255, otherwise it will be set to 0.
-
-**Parameters**
-
--   `threshold` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** a value in the range 0-255 representing the level at which the threshold will be applied. (optional, default `128`)
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
-    -   `options.greyscale` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** convert to single channel greyscale. (optional, default `true`)
-    -   `options.grayscale` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** alternative spelling for greyscale. (optional, default `true`)
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## boolean
-
-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.
-
-**Parameters**
-
--   `operand` **([Buffer](https://nodejs.org/api/buffer.html) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** Buffer containing image data or String containing the path to an image file.
--   `operator` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
-    -   `options.raw` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes operand when using raw pixel data.
-        -   `options.raw.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.raw.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.raw.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 

docs/api-output.md

@@ -1,200 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
-
--   [toFile](#tofile)
--   [toBuffer](#tobuffer)
--   [withMetadata](#withmetadata)
--   [jpeg](#jpeg)
--   [png](#png)
--   [webp](#webp)
--   [tiff](#tiff)
--   [raw](#raw)
--   [toFormat](#toformat)
--   [tile](#tile)
-
-## toFile
-
-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, TIFF, DZI, and libvips' V format supported.
-Note that raw pixel data is only supported for buffer output.
-
-A Promises/A+ promise is returned when `callback` is not provided.
-
-**Parameters**
-
--   `fileOut` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the path to write the image data to.
--   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)?** 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).
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** when no callback is provided
-
-## toBuffer
-
-Write output to a Buffer.
-JPEG, PNG, WebP, TIFF and RAW output are supported.
-By default, the format will match the input image, except GIF and SVG input which become PNG output.
-
-`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).
-    A Promise is returned when `callback` is not provided.
-
-**Parameters**
-
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
-    -   `options.resolveWithObject` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Resolve the Promise with an Object containing `data` and `info` properties instead of resolving only with `data`.
--   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)?** 
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Buffer](https://nodejs.org/api/buffer.html)>** when no callback is provided
-
-## withMetadata
-
-Include all metadata (EXIF, XMP, IPTC) from the input image in the output image.
-The default behaviour, when `withMetadata` is not used, is to strip all metadata and convert to the device-independent sRGB colour space.
-This will also convert to and add a web-friendly sRGB ICC profile.
-
-**Parameters**
-
--   `withMetadata` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
-    -   `withMetadata.orientation` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** value between 1 and 8, used to update the EXIF `Orientation` tag.
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## jpeg
-
-Use these JPEG options for output image.
-
-**Parameters**
-
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** output options
-    -   `options.quality` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** quality, integer 1-100 (optional, default `80`)
-    -   `options.progressive` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** use progressive (interlace) scan (optional, default `false`)
-    -   `options.chromaSubsampling` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** set to '4:4:4' to prevent chroma subsampling when quality &lt;= 90 (optional, default `'4:2:0'`)
-    -   `options.trellisQuantisation` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** apply trellis quantisation, requires mozjpeg (optional, default `false`)
-    -   `options.overshootDeringing` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** apply overshoot deringing, requires mozjpeg (optional, default `false`)
-    -   `options.optimiseScans` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** optimise progressive scans, forces progressive, requires mozjpeg (optional, default `false`)
-    -   `options.optimizeScans` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** alternative spelling of optimiseScans (optional, default `false`)
-    -   `options.force` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** force JPEG output, otherwise attempt to use input format (optional, default `true`)
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid options
-
-Returns **Sharp** 
-
-## png
-
-Use these PNG options for output image.
-
-**Parameters**
-
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
-    -   `options.progressive` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** use progressive (interlace) scan (optional, default `false`)
-    -   `options.compressionLevel` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** zlib compression level (optional, default `6`)
-    -   `options.adaptiveFiltering` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** use adaptive row filtering (optional, default `true`)
-    -   `options.force` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** force PNG output, otherwise attempt to use input format (optional, default `true`)
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid options
-
-Returns **Sharp** 
-
-## webp
-
-Use these WebP options for output image.
-
-**Parameters**
-
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** output options
-    -   `options.quality` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** quality, integer 1-100 (optional, default `80`)
-    -   `options.alphaQuality` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** quality of alpha layer, integer 0-100 (optional, default `100`)
-    -   `options.lossless` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** use lossless compression mode (optional, default `false`)
-    -   `options.nearLossless` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** use near_lossless compression mode (optional, default `false`)
-    -   `options.force` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** force WebP output, otherwise attempt to use input format (optional, default `true`)
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid options
-
-Returns **Sharp** 
-
-## tiff
-
-Use these TIFF options for output image.
-
-**Parameters**
-
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** output options
-    -   `options.quality` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** quality, integer 1-100 (optional, default `80`)
-    -   `options.force` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** force TIFF output, otherwise attempt to use input format (optional, default `true`)
-    -   `options.compression` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** compression options: lzw, deflate, jpeg (optional, default `'jpeg'`)
-    -   `options.predictor` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** compression predictor options: none, horizontal, float (optional, default `'none'`)
-    -   `options.squash` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** squash 8-bit images down to 1 bit (optional, default `false`)
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid options
-
-Returns **Sharp** 
-
-## raw
-
-Force output to be raw, uncompressed uint8 pixel data.
-
-Returns **Sharp** 
-
-## toFormat
-
-Force output to a given format.
-
-**Parameters**
-
--   `format` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** as a String or an Object with an 'id' attribute
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** output options
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** unsupported format or options
-
-Returns **Sharp** 
-
-## tile
-
-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.
-
-**Parameters**
-
--   `tile` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
-    -   `tile.size` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** tile size in pixels, a value between 1 and 8192. (optional, default `256`)
-    -   `tile.overlap` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** tile overlap in pixels, a value between 0 and 8192. (optional, default `0`)
-    -   `tile.container` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** tile container, with value `fs` (filesystem) or `zip` (compressed file). (optional, default `'fs'`)
-    -   `tile.layout` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** filesystem layout, possible values are `dz`, `zoomify` or `google`. (optional, default `'dz'`)
-
-**Examples**
-
-```javascript
-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
-  });
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 

docs/api-resize.md

@@ -1,177 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
-
--   [resize](#resize)
--   [crop](#crop)
--   [embed](#embed)
--   [max](#max)
--   [min](#min)
--   [ignoreAspectRatio](#ignoreaspectratio)
--   [withoutEnlargement](#withoutenlargement)
-
-## resize
-
-Resize image to `width` x `height`.
-By default, the resized image is centre cropped to the exact size specified.
-
-Possible reduction kernels are:
-
--   `nearest`: Use [nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation).
--   `cubic`: Use a [Catmull-Rom spline](https://en.wikipedia.org/wiki/Centripetal_Catmull%E2%80%93Rom_spline).
--   `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).
-
-Possible enlargement interpolators are:
-
--   `nearest`: Use [nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation).
--   `bilinear`: Use [bilinear interpolation](http://en.wikipedia.org/wiki/Bilinear_interpolation), faster than bicubic but with less smooth results.
--   `vertexSplitQuadraticBasisSpline`: Use the smoother [VSQBS interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/vsqbs.cpp#L48) to prevent "staircasing" when enlarging.
--   `bicubic`: Use [bicubic interpolation](http://en.wikipedia.org/wiki/Bicubic_interpolation) (the default).
--   `locallyBoundedBicubic`: Use [LBB interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/lbb.cpp#L100), which prevents some "[acutance](http://en.wikipedia.org/wiki/Acutance)" but typically reduces performance by a factor of 2.
--   `nohalo`: Use [Nohalo interpolation](http://eprints.soton.ac.uk/268086/), which prevents acutance but typically reduces performance by a factor of 3.
-
-**Parameters**
-
--   `width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** pixels wide the resultant image should be. Use `null` or `undefined` to auto-scale the width to match the height.
--   `height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** pixels high the resultant image should be. Use `null` or `undefined` to auto-scale the height to match the width.
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
-    -   `options.kernel` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the kernel to use for image reduction. (optional, default `'lanczos3'`)
-    -   `options.interpolator` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the interpolator to use for image enlargement. (optional, default `'bicubic'`)
-    -   `options.centreSampling` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** use \*magick centre sampling convention instead of corner sampling. (optional, default `false`)
-    -   `options.centerSampling` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** alternative spelling of centreSampling. (optional, default `false`)
-
-**Examples**
-
-```javascript
-sharp(inputBuffer)
-  .resize(200, 300, {
-    kernel: sharp.kernel.lanczos2,
-    interpolator: sharp.interpolator.nohalo
-  })
-  .background('white')
-  .embed()
-  .toFile('output.tiff')
-  .then(function() {
-    // output.tiff is a 200 pixels wide and 300 pixels high image
-    // containing a lanczos2/nohalo scaled version, embedded on a white canvas,
-    // of the image data in inputBuffer
-  });
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## crop
-
-Crop the resized image to the exact size specified, the default behaviour.
-
-Possible attributes of the optional `sharp.gravity` are `north`, `northeast`, `east`, `southeast`, `south`,
-`southwest`, `west`, `northwest`, `center` and `centre`.
-
-The experimental strategy-based approach 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.
-
-**Parameters**
-
--   `crop` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** A member of `sharp.gravity` to crop to an edge/corner or `sharp.strategy` to crop dynamically. (optional, default `'centre'`)
-
-**Examples**
-
-```javascript
-const transformer = sharp()
-  .resize(200, 200)
-  .crop(sharp.strategy.entropy)
-  .on('error', function(err) {
-    console.log(err);
-  });
-// Read image data from readableStream
-// Write 200px square auto-cropped image data to writableStream
-readableStream.pipe(transformer).pipe(writableStream);
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## embed
-
-Preserving aspect ratio, resize the image to the maximum `width` or `height` specified
-then embed on a background of the exact `width` and `height` specified.
-
-If the background contains an alpha value then WebP and PNG format output images will
-contain an alpha channel, even when the input image does not.
-
-**Examples**
-
-```javascript
-sharp('input.gif')
-  .resize(200, 300)
-  .background({r: 0, g: 0, b: 0, alpha: 0})
-  .embed()
-  .toFormat(sharp.format.webp)
-  .toBuffer(function(err, outputBuffer) {
-    if (err) {
-      throw err;
-    }
-    // outputBuffer contains WebP image data of a 200 pixels wide and 300 pixels high
-    // containing a scaled version, embedded on a transparent canvas, of input.gif
-  });
-```
-
-Returns **Sharp** 
-
-## max
-
-Preserving aspect ratio, resize the image to be as large as possible
-while ensuring its dimensions are less than or equal to the `width` and `height` specified.
-
-Both `width` and `height` must be provided via `resize` otherwise the behaviour will default to `crop`.
-
-**Examples**
-
-```javascript
-sharp(inputBuffer)
-  .resize(200, 200)
-  .max()
-  .toFormat('jpeg')
-  .toBuffer()
-  .then(function(outputBuffer) {
-    // outputBuffer contains JPEG image data no wider than 200 pixels and no higher
-    // than 200 pixels regardless of the inputBuffer image dimensions
-  });
-```
-
-Returns **Sharp** 
-
-## min
-
-Preserving aspect ratio, resize the image to be as small as possible
-while ensuring its dimensions are greater than or equal to the `width` and `height` specified.
-
-Both `width` and `height` must be provided via `resize` otherwise the behaviour will default to `crop`.
-
-Returns **Sharp** 
-
-## ignoreAspectRatio
-
-Ignoring the aspect ratio of the input, stretch the image to
-the exact `width` and/or `height` provided via `resize`.
-
-Returns **Sharp** 
-
-## withoutEnlargement
-
-Do not enlarge the output image if the input image width _or_ height are already less than the required dimensions.
-This is equivalent to GraphicsMagick's `>` geometry option:
-"_change the dimensions of the image only if its width or height exceeds the geometry specification_".
-
-**Parameters**
-
--   `withoutEnlargement` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**  (optional, default `true`)
-
-Returns **Sharp** 

docs/api-utility.md

@@ -1,106 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
-
--   [cache](#cache)
--   [concurrency](#concurrency)
--   [counters](#counters)
--   [simd](#simd)
-
-## cache
-
-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.
-
-**Parameters**
-
--   `options` **([Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) \| [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean))** Object with the following attributes, or Boolean where true uses default cache settings and false removes all caching.
-    -   `options.memory` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** is the maximum memory in MB to use for this cache (optional, default `50`)
-    -   `options.files` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** is the maximum number of files to hold open (optional, default `20`)
-    -   `options.items` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** is the maximum number of operations to cache (optional, default `100`)
-
-**Examples**
-
-```javascript
-const stats = sharp.cache();
-```
-
-```javascript
-sharp.cache( { items: 200 } );
-sharp.cache( { files: 0 } );
-sharp.cache(false);
-```
-
-Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-
-## concurrency
-
-Gets, or when a concurrency is provided sets,
-the number of threads _libvips'_ should create to process each image.
-The default value is the number of CPU cores.
-A value of `0` will reset to this default.
-
-The maximum number of images that can be processed in parallel
-is limited by libuv's `UV_THREADPOOL_SIZE` environment variable.
-
-This method always returns the current concurrency.
-
-**Parameters**
-
--   `concurrency` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-
-**Examples**
-
-```javascript
-const threads = sharp.concurrency(); // 4
-sharp.concurrency(2); // 2
-sharp.concurrency(0); // 4
-```
-
-Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** concurrency
-
-## counters
-
-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.
-
-**Examples**
-
-```javascript
-const counters = sharp.counters(); // { queue: 2, process: 4 }
-```
-
-Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-
-## simd
-
-Get and set use of SIMD vector unit instructions.
-Requires libvips to have been compiled with liborc 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.
-
-This feature is currently off by default but future versions may reverse this.
-Versions of liborc prior to 0.4.25 are known to segfault under heavy load.
-
-**Parameters**
-
--   `simd` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**  (optional, default `false`)
-
-**Examples**
-
-```javascript
-const simd = sharp.simd();
-// simd is `true` if SIMD is currently enabled
-```
-
-```javascript
-const simd = sharp.simd(true);
-// attempts to enable the use of SIMD, returning true if available
-```
-
-Returns **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 

docs/astro.config.mjs

@@ -0,0 +1,79 @@
+// @ts-check
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+
+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', slug: 'changelog' }
+      ],
+      social: {
+        openCollective: 'https://opencollective.com/libvips',
+        github: 'https://github.com/lovell/sharp'
+      }
+    })
+  ]
+});

docs/build.mjs

@@ -0,0 +1,42 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
+'use strict';
+
+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);
+});

docs/changelog.md

@@ -1,599 +0,0 @@
-# Changelog
-
-### v0.18 - "*ridge*"
-
-Requires libvips v8.5.5.
-
-#### v0.18.1 - 30<sup>th</sup> May 2017
-
-* Remove regression from #781 that could cause incorrect shrink calculation.
-  [#831](https://github.com/lovell/sharp/issues/831)
-  [@suprMax](https://github.com/suprMax)
-
-#### v0.18.0 - 30<sup>th</sup> May 2017
-
-* 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)
-
-### v0.17 - "*quill*"
-
-Requires libvips v8.4.2.
-
-#### v0.17.3 - 1<sup>st</sup> April 2017
-
-* 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)
-
-#### v0.17.2 - 11<sup>th</sup> February 2017
-
-* 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)
-
-#### v0.17.1 - 15<sup>th</sup> January 2017
-
-* 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)
-
-#### v0.17.0 - 11<sup>th</sup> December 2016
-
-* 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)
-
-### v0.16 - "*pencil*"
-
-Requires libvips v8.3.3
-
-#### v0.16.2 - 22<sup>nd</sup> October 2016
-
-* Restrict readelf usage to Linux only when detecting global libvips version.
-  [#602](https://github.com/lovell/sharp/issues/602)
-  [@caoko](https://github.com/caoko)
-
-#### v0.16.1 - 13<sup>th</sup> October 2016
-
-* 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)
-
-#### v0.16.0 - 18<sup>th</sup> August 2016
-
-* 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)
-
-### v0.15 - "*outfit*"
-
-Requires libvips v8.3.1
-
-#### v0.15.1 - 12<sup>th</sup> July 2016
-
-* 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)
-
-#### v0.15.0 - 21<sup>st</sup> May 2016
-
-* 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)
-
-### v0.14 - "*needle*"
-
-Requires libvips v8.2.3
-
-#### v0.14.1 - 16<sup>th</sup> April 2016
-
-* 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)
-
-#### v0.14.0 - 2<sup>nd</sup> April 2016
-
-* 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)
-
-### v0.13 - "*mind*"
-
-Requires libvips v8.2.2
-
-#### v0.13.1 - 27<sup>th</sup> February 2016
-
-* Fix embedding onto transparent backgrounds; regression introduced in v0.13.0.
-  [#366](https://github.com/lovell/sharp/issues/366)
-  [@diegocsandrim](https://github.com/diegocsandrim)
-
-#### v0.13.0 - 15<sup>th</sup> February 2016
-
-* 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.
-
-### v0.12 - "*look*"
-
-Requires libvips v8.2.0
-
-#### v0.12.2 - 16<sup>th</sup> January 2016
-
-* 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)
-
-#### v0.12.1 - 12<sup>th</sup> December 2015
-
-* 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.
-
-#### v0.12.0 - 23<sup>rd</sup> November 2015
-
-* 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)
-
-### v0.11 - "*knife*"
-
-#### v0.11.4 - 5<sup>th</sup> November 2015
-
-* 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)
-
-#### v0.11.3 - 8<sup>th</sup> September 2015
-
-* Intrepret blurSigma, sharpenFlat, and sharpenJagged as double precision.
-  [#263](https://github.com/lovell/sharp/pull/263)
-  [@chrisriley](https://github.com/chrisriley)
-
-#### v0.11.2 - 28<sup>th</sup> August 2015
-
-* 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)
-
-#### v0.11.1 - 12<sup>th</sup> August 2015
-
-* 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)
-
-#### v0.11.0 - 15<sup>th</sup> July 2015
-
-* 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)
-
-### v0.10 - "*judgment*"
-
-#### v0.10.1 - 1<sup>st</sup> June 2015
-
-* 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)
-
-#### v0.10.0 - 23<sup>rd</sup> April 2015
-
-* 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)

docs/firebase.json

@@ -0,0 +1,16 @@
+{
+  "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" }
+        ]
+      }
+    ]
+  }
+}

docs/index.md

@@ -1,119 +0,0 @@
-# sharp
-
-The typical use case for this high speed Node.js module
-is to convert large images in common formats to
-smaller, web-friendly JPEG, PNG and WebP images of varying dimensions.
-
-Resizing an image is typically 4x-5x faster than using the
-quickest ImageMagick and GraphicsMagick settings.
-
-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.
-
-OS X, Windows (x64), Linux (x64, ARM) systems do not require
-the installation of any external runtime dependencies.
-
-[![Test Coverage](https://coveralls.io/repos/lovell/sharp/badge.png?branch=master)](https://coveralls.io/r/lovell/sharp?branch=master)
-
-### Formats
-
-This module supports reading JPEG, PNG, WebP, TIFF, GIF and SVG images.
-
-Output images can be in JPEG, PNG, WebP and TIFF formats as well as uncompressed raw pixel data.
-
-Streams, Buffer objects and the filesystem can be used for input and output.
-
-A single input Stream can be split into multiple processing pipelines and output Streams.
-
-Deep Zoom image pyramids can be generated,
-suitable for use with "slippy map" tile viewers like
-[OpenSeadragon](https://github.com/openseadragon/openseadragon)
-and [Leaflet](https://github.com/turban/Leaflet.Zoomify).
-
-### Fast
-
-This module is powered by the blazingly fast
-[libvips](https://github.com/jcupitt/libvips) image processing library,
-originally created in 1989 at Birkbeck College
-and currently maintained by
-[John Cupitt](https://github.com/jcupitt).
-
-Only small regions of uncompressed image data
-are held in memory and processed at a time,
-taking full advantage of multiple CPU cores and L1/L2/L3 cache.
-
-Everything remains non-blocking thanks to _libuv_,
-no child processes are spawned and Promises/A+ are supported.
-
-### Optimal
-
-Huffman tables are optimised when generating JPEG output images
-without having to use separate command line tools like
-[jpegoptim](https://github.com/tjko/jpegoptim) and
-[jpegtran](http://jpegclub.org/jpegtran/).
-
-PNG filtering can be disabled,
-which for diagrams and line art often produces the same result
-as [pngcrush](http://pmt.sourceforge.net/pngcrush/).
-
-### Contributing
-
-A [guide for contributors](https://github.com/lovell/sharp/blob/master/CONTRIBUTING.md)
-covers reporting bugs, requesting features and submitting code changes.
-
-### Credits
-
-This module would never have been possible without
-the help and code contributions of the following people:
-
-* [John Cupitt](https://github.com/jcupitt)
-* [Pierre Inglebert](https://github.com/pierreinglebert)
-* [Jonathan Ong](https://github.com/jonathanong)
-* [Chanon Sajjamanochai](https://github.com/chanon)
-* [Juliano Julio](https://github.com/julianojulio)
-* [Daniel Gasienica](https://github.com/gasi)
-* [Julian Walker](https://github.com/julianwa)
-* [Amit Pitaru](https://github.com/apitaru)
-* [Brandon Aaron](https://github.com/brandonaaron)
-* [Andreas Lind](https://github.com/papandreou)
-* [Maurus Cuelenaere](https://github.com/mcuelenaere)
-* [Linus Unnebäck](https://github.com/LinusU)
-* [Victor Mateevitsi](https://github.com/mvictoras)
-* [Alaric Holloway](https://github.com/skedastik)
-* [Bernhard K. Weisshuhn](https://github.com/bkw)
-* [David A. Carley](https://github.com/dacarley)
-* [John Tobin](https://github.com/jtobinisaniceguy)
-* [Kenton Gray](https://github.com/kentongray)
-* [Felix Bünemann](https://github.com/felixbuenemann)
-* [Samy Al Zahrani](https://github.com/salzhrani)
-* [Chintan Thakkar](https://github.com/lemnisk8)
-* [F. Orlando Galashan](https://github.com/frulo)
-* [Kleis Auke Wolthuizen](https://github.com/kleisauke)
-* [Matt Hirsch](https://github.com/mhirsch)
-* [Rahul Nanwani](https://github.com/rnanwani)
-* [Matthias Thoemmes](https://github.com/cmtt)
-* [Patrick Paskaris](https://github.com/ppaskaris)
-* [Jérémy Lal](https://github.com/kapouer)
-* [Alice Monday](https://github.com/alice0meta)
-* [Kristo Jorgenson](https://github.com/kristojorg)
-* [Yves Bos](https://github.com/YvesBos)
-
-Thank you!
-
-### Licence
-
-Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
-
-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](http://www.apache.org/licenses/LICENSE-2.0.html)
-
-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.

docs/install.md

@@ -1,229 +0,0 @@
-# Installation
-
-```sh
-npm install sharp
-```
-
-```sh
-yarn add sharp
-```
-
-### Prerequisites
-
-* Node v4+
-* C++11 compatible compiler such as gcc 4.8+, clang 3.0+ or MSVC 2013+
-* [node-gyp](https://github.com/TooTallNate/node-gyp#installation) and its dependencies (includes Python)
-
-### Linux
-
-[![Ubuntu 14.04 Build Status](https://travis-ci.org/lovell/sharp.png?branch=master)](https://travis-ci.org/lovell/sharp)
-[![Linux Build Status](https://circleci.com/gh/lovell/sharp.svg?style=svg&circle-token=6cb6d1d287a51af83722b19ed8885377fbc85e5c)](https://circleci.com/gh/lovell/sharp)
-
-libvips and its dependencies are fetched and stored within `node_modules/sharp/vendor` during `npm install`.
-This involves an automated HTTPS download of approximately 7MB.
-
-Most recent Linux-based operating systems with glibc running on x64 and ARMv6+ CPUs should "just work", e.g.:
-
-* Debian 7, 8
-* Ubuntu 12.04, 14.04, 16.04
-* Centos 7
-* Fedora
-* openSUSE 13.2
-* Archlinux
-* Raspbian Jessie
-* Amazon Linux 2016.03, 2016.09
-
-To use a globally-installed version of libvips instead of the provided binaries,
-make sure it is at least the version listed under `config.libvips` in the `package.json` file
-and that it can be located using `pkg-config --modversion vips-cpp`.
-
-If you are using non-stadard paths (anything other than `/usr` or `/usr/local`),
-you might need to set `PKG_CONFIG_PATH` during `npm install`
-and `LD_LIBRARY_PATH` at runtime.
-
-This allows the use of newer versions of libvips with older versions of sharp.
-
-For 32-bit Intel CPUs and older Linux-based operating systems such as Centos 6,
-it is recommended to install a system-wide installation of libvips from source:
-
-https://github.com/jcupitt/libvips#building-libvips-from-a-source-tarball
-
-For Linux-based operating systems such as Alpine that use musl libc,
-the smaller stack size means libvips' cache should be disabled
-via `sharp.cache(false)` to avoid a stack overflow.
-
-### Mac OS
-
-[![OS X 10.9.5 Build Status](https://travis-ci.org/lovell/sharp.png?branch=master)](https://travis-ci.org/lovell/sharp)
-
-libvips and its dependencies are fetched and stored within `node_modules/sharp/vendor` during `npm install`.
-This involves an automated HTTPS download of approximately 7MB.
-
-To use your own version of libvips instead of the provided binaries, make sure it is
-at least the version listed under `config.libvips` in the `package.json` file and
-that it can be located using `pkg-config --modversion vips-cpp`.
-
-### Windows x64
-
-[![Windows x64 Build Status](https://ci.appveyor.com/api/projects/status/pgtul704nkhhg6sg)](https://ci.appveyor.com/project/lovell/sharp)
-
-libvips and its dependencies are fetched and stored within `node_modules\sharp\vendor` during `npm install`.
-This involves an automated HTTPS download of approximately 11MB.
-
-Only 64-bit (x64) `node.exe` is supported.
-
-### FreeBSD
-
-libvips must be installed before `npm install` is run.
-This can be achieved via [FreshPorts](https://www.freshports.org/graphics/vips/):
-
-```sh
-cd /usr/ports/graphics/vips/ && make install clean
-```
-
-### Heroku
-
-libvips and its dependencies are fetched and stored within `node_modules\sharp\vendor` during `npm install`.
-This involves an automated HTTPS download of approximately 7MB.
-
-Set [NODE_MODULES_CACHE](https://devcenter.heroku.com/articles/nodejs-support#cache-behavior)
-to `false` when using the `yarn` package manager.
-
-### Docker
-
-[Marc Bachmann](https://github.com/marcbachmann) maintains an
-[Ubuntu-based Dockerfile for libvips](https://github.com/marcbachmann/dockerfile-libvips).
-
-```sh
-docker pull marcbachmann/libvips
-```
-
-[Will Jordan](https://github.com/wjordan) maintains an
-[Alpine-based Dockerfile for libvips](https://github.com/wjordan/dockerfile-libvips).
-
-```sh
-docker pull wjordan/libvips
-```
-
-[Tailor Brands](https://github.com/TailorBrands) maintain
-[Debian-based Dockerfiles for libvips and nodejs](https://github.com/TailorBrands/docker-libvips).
-
-```sh
-docker pull tailor/docker-libvips
-```
-
-### AWS Lambda
-
-In order to use sharp on AWS Lambda, you need to [create a deployment package](http://docs.aws.amazon.com/lambda/latest/dg/nodejs-create-deployment-pkg.html). Because sharp
-downloads and links libraries for the current platform during `npm install` you have to
-do this on a system similar to the [Lambda Execution Environment](http://docs.aws.amazon.com/lambda/latest/dg/current-supported-versions.html). The easiest ways to do this, is to setup a
-small t2.micro instance using the AMI ID listed in the previous link, ssh into it as ec2-user
-and follow the instructions below.
-
-Install dependencies:
-
-```sh
-curl -s https://rpm.nodesource.com/setup_4.x | sudo bash -
-sudo yum install -y gcc-c++ nodejs
-```
-
-Copy your code and package.json to the instance using `scp` and create a deployment package:
-
-```sh
-cd sharp-lambda-example
-npm install
-zip -ur9 ../sharp-lambda-example.zip index.js node_modules
-```
-
-You can now download your deployment ZIP using `scp` and upload it to Lambda. Be sure to set your Lambda runtime to Node.js 4.3.
-
-**Performance Tip:** To get the best performance on Lambda choose the largest memory available because this also gives you the most cpu time (a 1536 MB function is 12x faster than a 128 MB function).
-
-### Build tools
-
-* [gulp-responsive](https://www.npmjs.com/package/gulp-responsive)
-* [grunt-sharp](https://www.npmjs.com/package/grunt-sharp)
-
-### CLI tools
-
-* [sharp-cli](https://www.npmjs.com/package/sharp-cli)
-
-### Security
-
-Many users of this module process untrusted, user-supplied images,
-but there are aspects of security to consider when doing so.
-
-It is possible to compile libvips with support for various third-party image loaders.
-Each of these libraries has undergone differing levels of security testing.
-
-Whilst tools such as [American Fuzzy Lop](http://lcamtuf.coredump.cx/afl/)
-and [Valgrind](http://valgrind.org/) have been used to test
-the most popular web-based formats, as well as libvips itself,
-you are advised to perform your own testing and sandboxing.
-
-ImageMagick in particular has a relatively large attack surface,
-which can be partially mitigated with a
-[policy.xml](http://www.imagemagick.org/script/resources.php)
-configuration file to prevent the use of coders known to be vulnerable.
-
-```xml
-<policymap>
-  <policy domain="coder" rights="none" pattern="EPHEMERAL" />
-  <policy domain="coder" rights="none" pattern="URL" />
-  <policy domain="coder" rights="none" pattern="HTTPS" />
-  <policy domain="coder" rights="none" pattern="MVG" />
-  <policy domain="coder" rights="none" pattern="MSL" />
-  <policy domain="coder" rights="none" pattern="TEXT" />
-  <policy domain="coder" rights="none" pattern="SHOW" />
-  <policy domain="coder" rights="none" pattern="WIN" />
-  <policy domain="coder" rights="none" pattern="PLT" />
-</policymap>
-```
-
-Set the `MAGICK_CONFIGURE_PATH` environment variable
-to the directory containing the `policy.xml` file.
-
-### Licences
-
-If a global installation of libvips that meets the
-minimum version requirement cannot be found,
-this module will download a pre-compiled bundle of libvips
-and its dependencies on Linux and Windows machines.
-
-Should you need to manually download and inspect these files,
-you can do so via https://dl.bintray.com/lovell/sharp/
-
-This module is licensed under the terms of the
-[Apache 2.0 Licence](https://github.com/lovell/sharp/blob/master/LICENSE).
-
-The libraries downloaded and used by this module
-are done so under the terms of the following licences,
-all of which are compatible with the Apache 2.0 Licence.
-
-Use of libraries under the terms of the LGPLv3 is via the
-"any later version" clause of the LGPLv2 or LGPLv2.1.
-
-| Library       | Used under the terms of                                                                                  |
-|---------------|----------------------------------------------------------------------------------------------------------|
-| cairo         | Mozilla Public License 2.0                                                                               |
-| expat         | MIT Licence                                                                                              |
-| fontconfig    | [fontconfig Licence](https://cgit.freedesktop.org/fontconfig/tree/COPYING) (BSD-like)                    |
-| freetype      | [freetype Licence](http://git.savannah.gnu.org/cgit/freetype/freetype2.git/tree/docs/FTL.TXT) (BSD-like) |
-| giflib        | MIT Licence                                                                                              |
-| glib          | LGPLv3                                                                                                   |
-| harfbuzz      | MIT Licence                                                                                              |
-| lcms          | MIT Licence                                                                                              |
-| libcroco      | LGPLv3                                                                                                   |
-| libexif       | LGPLv3                                                                                                   |
-| libffi        | MIT Licence                                                                                              |
-| libgsf        | LGPLv3                                                                                                   |
-| libjpeg-turbo | [zlib License, IJG License](https://github.com/libjpeg-turbo/libjpeg-turbo/blob/master/LICENSE.md)       |
-| libpng        | [libpng License](http://www.libpng.org/pub/png/src/libpng-LICENSE.txt)                                   |
-| librsvg       | LGPLv3                                                                                                   |
-| libtiff       | [libtiff License](http://www.libtiff.org/misc.html) (BSD-like)                                           |
-| libvips       | LGPLv3                                                                                                   |
-| libwebp       | New BSD License                                                                                          |
-| libxml2       | MIT Licence                                                                                              |
-| pango         | LGPLv3                                                                                                   |
-| pixman        | MIT Licence                                                                                              |
-| zlib          | [zlib Licence](https://github.com/madler/zlib/blob/master/zlib.h)                                        |

docs/package.json

@@ -0,0 +1,17 @@
+{
+  "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.32.3",
+    "astro": "^5.5.3"
+  }
+}

docs/performance.md

@@ -1,73 +0,0 @@
-# Performance
-
-### Test environment
-
-* AWS EC2 eu-central-1 [c4.xlarge](http://aws.amazon.com/ec2/instance-types/#c4) (4x E5-2666 v3 @ 2.90GHz)
-* Ubuntu 16.04.1 LTS (HVM, SSD, 20161115, ami-82cf0aed)
-* Node.js v6.9.1
-
-### The contenders
-
-* [jimp](https://www.npmjs.com/package/jimp) v0.2.27 - Image processing in pure JavaScript. Bilinear interpolation only.
-* [lwip](https://www.npmjs.com/package/lwip) v0.0.9 - Wrapper around CImg. Compiles outdated, insecure dependencies from source.
-* [mapnik](https://www.npmjs.org/package/mapnik) v3.5.14 - Whilst primarily a map renderer, Mapnik contains bitmap image utilities.
-* [imagemagick-native](https://www.npmjs.com/package/imagemagick-native) v1.9.3 - Wrapper around libmagick++, supports Buffers only.
-* [imagemagick](https://www.npmjs.com/package/imagemagick) v0.1.3 - Supports filesystem only and "*has been unmaintained for a long time*".
-* [gm](https://www.npmjs.com/package/gm) v1.23.0 - Fully featured wrapper around GraphicsMagick's `gm` command line utility.
-* sharp v0.17.0 / libvips v8.4.2 - Caching within libvips disabled to ensure a fair comparison.
-
-### The task
-
-Decompress a 2725x2225 JPEG image,
-resize to 720x588 using Lanczos 3 resampling (where available),
-then compress to JPEG at a "quality" setting of 80.
-
-### Results
-
-| Module             | Input  | Output | Ops/sec | Speed-up |
-| :----------------- | :----- | :----- | ------: | -------: |
-| jimp (bilinear)    | buffer | buffer |    1.06 |      1.0 |
-| lwip               | buffer | buffer |    1.87 |      1.8 |
-| mapnik             | buffer | buffer |    2.91 |      2.7 |
-| imagemagick-native | buffer | buffer |    4.03 |      3.8 |
-| imagemagick        | file   | file   |    7.10 |      6.7 |
-| gm                 | buffer | buffer |    7.08 |      6.7 |
-| gm                 | file   | file   |    7.10 |      6.7 |
-| sharp              | stream | stream |   27.61 |     26.0 |
-| sharp              | file   | file   |   28.41 |     26.8 |
-| sharp              | buffer | file   |   28.71 |     27.1 |
-| sharp              | file   | buffer |   28.60 |     27.0 |
-| sharp              | buffer | buffer |   29.08 |     27.4 |
-
-Greater libvips performance can be expected with caching enabled (default)
-and using 8+ core machines, especially those with larger L1/L2 CPU caches.
-
-The I/O limits of the relevant (de)compression library will generally determine maximum throughput.
-
-### Benchmark test prerequisites
-
-Requires both _ImageMagick_ and _GraphicsMagick_:
-
-```sh
-brew install imagemagick
-brew install graphicsmagick
-```
-
-```sh
-sudo apt-get install imagemagick libmagick++-dev graphicsmagick
-```
-
-```sh
-sudo yum install ImageMagick-devel ImageMagick-c++-devel GraphicsMagick
-```
-
-### Running the benchmark test
-
-```sh
-git clone https://github.com/lovell/sharp.git
-cd sharp
-npm install
-cd test/bench
-npm install
-npm test
-```

docs/public/api-resize-fit.svg

@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="utf-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="998" height="243" viewBox="0 0 998 243">
+  <defs>
+    <g id="placeholder">
+      <rect width="180" height="128" fill="#64bed8"/>
+      <circle cx="61.1" cy="36.8" r="19.3" fill="#ffefa9"/>
+      <circle cx="61.1" cy="36.8" r="18.1" fill="#fdda42"/>
+      <path d="m67.2 34.7 15.2 46L90 57.9l30.4 38 7.8-15.2 7.5 15.4H44z" fill="#6a696f"/>
+      <path d="m82.4 80.7-15.2-46-.3 69h22.9z" fill="#474749"/>
+      <path d="m90.1 58 12.2 15 18.2 23-13.9.1z" fill="#474749"/>
+      <path d="M135.8 96H131l-2.8-15.3z" fill="#474749"/>
+      <path d="M35.2 96h107.1c0 1.7-1.4 3.2-3.2 3.2H38.4a3.2 3.2 0 0 1-3.2-3.2z" fill="#b9c861"/>
+      <path d="m67.2 34.7-.1 31-6.2-3-5.3 2.7z" fill="#fff"/>
+      <path d="m67.2 34.7 7.6 23-7.7 8z" fill="#b3b1b4"/>
+      <rect width="30.8" height="7.7" x="71.1" y="27.2" rx="2.8" ry="4.1" fill="#fff"/>
+      <rect width="30.8" height="7.7" x="82.2" y="34.8" rx="2.8" ry="4.1" fill="#fff"/>
+      <rect width="30.8" height="7.7" x="36.2" y="19.6" rx="2.8" ry="4.1" fill="#fff"/>
+      <path d="m89.6 72.8-7.2 7.9L90 57.9l10 23z" fill="#fff"/>
+      <path d="m90.1 58 10 23 2.2-8z" fill="#b3b1b4"/>
+      <path d="M131.2 85.2 137 68l9 17.2-8 6z" fill="#8da128"/>
+      <rect width="109.4" height="6.8" x="33.9" y="99.1" rx="13.2" ry="11.4" fill="#22b0d6"/>
+      <path d="m137 68-5.8 17.2 6.8 6.1.3-13.7z" fill="#727d2e"/>
+      <rect width="83.3" height="6.8" x="50.8" y="103.6" rx="10" ry="11.4" fill="#22b0d6"/>
+      <rect width=".7" height="18.4" x="138" y="77.6" fill="#585657"/>
+      <rect width=".5" height="5.2" x="2" y="-161.3" fill="#585657" transform="rotate(120)"/>
+      <rect width=".5" height="5.3" x="5.5" y="-163.3" fill="#585657" transform="rotate(120)"/>
+      <rect width=".5" height="4.8" x="-142.4" y="77.7" fill="#585657" transform="rotate(240)"/>
+      <rect width=".5" height="5.1" x="-146" y="75.6" fill="#585657" transform="rotate(240)"/>
+    </g>
+    <pattern id="img" height="100%" width="100%" viewBox="0 0 180 128">
+      <use xlink:href="#placeholder"/>
+    </pattern>
+    <pattern id="img-fill" width="100%" height="100%" viewBox="0 0 180 128" preserveAspectRatio="none">
+      <use xlink:href="#placeholder"/>
+    </pattern>
+  </defs>
+  <rect x="0" y="0" width="998" height="243" fill="#ddd"/>
+  <g id="cover">
+    <rect x="22" y="28" width="180" height="132" fill="url(#img)"/>
+    <rect x="48" y="30" width="128" height="128" fill="none" stroke="#000" stroke-width="4"/>
+    <text x="112" y="85%" dominant-baseline="middle" text-anchor="middle" font-family="sans" font-size="32" font-weight="bold">cover</text>
+  </g>
+  <g id="contain">
+    <rect x="240" y="30" width="128" height="128" fill="url(#img)" stroke="#000" stroke-width="4"/>
+    <text x="304" y="85%" dominant-baseline="middle" text-anchor="middle" font-family="sans" font-size="32" font-weight="bold" fill="#555">contain</text>
+  </g>
+  <g id="fill">
+    <rect x="432" y="30" width="128" height="128" fill="url(#img-fill)" stroke="#000" stroke-width="4"/>
+    <text x="496" y="85%" dominant-baseline="middle" text-anchor="middle" font-family="sans" font-size="32" font-weight="bold">fill</text>
+  </g>
+  <g id="inside">
+    <rect x="624" y="48" width="128" height="92" fill="url(#img)" stroke="#000" stroke-width="4"/>
+    <rect x="624" y="30" width="128" height="128" fill="none" stroke="#000" stroke-width="4" stroke-dasharray="12 4" stroke-dashoffset="6"/>
+    <text x="688" y="85%" dominant-baseline="middle" text-anchor="middle" font-family="sans" font-size="32" font-weight="bold" fill="#555">inside</text>
+  </g>
+  <g id="outside">
+    <rect x="792" y="30" width="176" height="128" fill="url(#img)" stroke="#000" stroke-width="4"/>
+    <rect x="816" y="30" width="128" height="128" fill="none" stroke="#000" stroke-width="4" stroke-dasharray="12 4" stroke-dashoffset="-2"/>
+    <text x="880" y="85%" dominant-baseline="middle" text-anchor="middle" font-family="sans" font-size="32" font-weight="bold">outside</text>
+  </g>
+</svg>

docs/public/favicon.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="86 86 550 550">
+<!-- Creative Commons CC0 1.0 Universal Public Domain Dedication -->
+<path fill="none" stroke="#9c0" stroke-width="80" d="M258.411 285.777l200.176-26.8M244.113 466.413L451.44 438.66M451.441 438.66V238.484M451.441 88.363v171.572l178.725-23.917M270.323 255.602V477.22M272.71 634.17V462.591L93.984 486.515"/>
+<path fill="none" stroke="#090" stroke-width="80" d="M451.441 610.246V438.66l178.725-23.91M269.688 112.59v171.58L90.964 308.093"/>
+</svg>

docs/public/humans.txt

@@ -0,0 +1,322 @@
+/* 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

docs/public/robots.txt

@@ -0,0 +1,4 @@
+User-agent: *
+Disallow:
+
+Sitemap: https://sharp.pixelplumbing.com/sitemap-index.xml

docs/public/sharp-logo-mono.svg

@@ -0,0 +1,11 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="86 86 550 550">
+<!-- Creative Commons CC0 1.0 Universal Public Domain Dedication -->
+  <defs>
+    <mask id="c">
+      <path fill="none" stroke="#fff" stroke-width="80" d="M258.411 285.777l200.176-26.8M244.113 466.413L451.44 438.66m.001 0V238.484m0-150.121v171.572l178.725-23.917m-359.843 19.584V477.22m2.387 156.95V462.591L93.984 486.515"/>
+      <path fill="none" stroke="#000" stroke-width="112" d="M451.441 610.246V438.66l178.725-23.91M269.688 112.59v171.58L90.964 308.093"/>
+    </mask>
+  </defs>
+  <path mask="url(#c)" fill="none" stroke="#000" stroke-width="80" d="M258.411 285.777l200.176-26.8M244.113 466.413L451.44 438.66m.001 0V238.484m0-150.121v171.572l178.725-23.917m-359.843 19.584V477.22m2.387 156.95V462.591L93.984 486.515"/>
+  <path fill="none" stroke="#000" stroke-width="80" d="M451.441 610.246V438.66l178.725-23.91M269.688 112.59v171.58L90.964 308.093"/>
+</svg>

docs/public/sharp-logo.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="86 86 550 550">
+<!-- Creative Commons CC0 1.0 Universal Public Domain Dedication -->
+<path fill="none" stroke="#9c0" stroke-width="80" d="M258.411 285.777l200.176-26.8M244.113 466.413L451.44 438.66M451.441 438.66V238.484M451.441 88.363v171.572l178.725-23.917M270.323 255.602V477.22M272.71 634.17V462.591L93.984 486.515"/>
+<path fill="none" stroke="#090" stroke-width="80" d="M451.441 610.246V438.66l178.725-23.91M269.688 112.59v171.58L90.964 308.093"/>
+</svg>

docs/src/assets/sharp-logo.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="86 86 550 550">
+<!-- Creative Commons CC0 1.0 Universal Public Domain Dedication -->
+<path fill="none" stroke="#9c0" stroke-width="80" d="M258.411 285.777l200.176-26.8M244.113 466.413L451.44 438.66M451.441 438.66V238.484M451.441 88.363v171.572l178.725-23.917M270.323 255.602V477.22M272.71 634.17V462.591L93.984 486.515"/>
+<path fill="none" stroke="#090" stroke-width="80" d="M451.441 610.246V438.66l178.725-23.91M269.688 112.59v171.58L90.964 308.093"/>
+</svg>

docs/src/content.config.ts

@@ -0,0 +1,7 @@
+import { defineCollection } from 'astro:content';
+import { docsLoader } from '@astrojs/starlight/loaders';
+import { docsSchema } from '@astrojs/starlight/schema';
+
+export const collections = {
+	docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
+};

docs/src/content/docs/api-channel.md

@@ -0,0 +1,141 @@
+---
+# 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.
+
+
+**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.&lt;(string\|Buffer)&gt;</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`.
+  });
+```

docs/src/content/docs/api-colour.md

@@ -0,0 +1,150 @@
+---
+# 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://github.com/libvips/libvips/blob/41cff4e9d0838498487a00623462204eb10ee5b8/libvips/iofuncs/enumtypes.c#L774) |
+
+**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://github.com/libvips/libvips/blob/3c0bfdf74ce1dc37a6429bed47fa76f16e2cd70a/libvips/iofuncs/enumtypes.c#L777-L794) |
+
+**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. |

docs/src/content/docs/api-composite.md

@@ -0,0 +1,103 @@
+---
+# 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/libvips-conversion.html#VipsBlendMode
+and https://www.cairographics.org/operators/
+
+
+**Throws**:
+
+- <code>Error</code> Invalid parameters
+
+**Since**: 0.22.0  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| images | <code>Array.&lt;Object&gt;</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>&quot;&#x27;left&#x27;&quot;</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>&#x27;over&#x27;</code> | how to blend this image with the image below. |
+| [images[].gravity] | <code>String</code> | <code>&#x27;centre&#x27;</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>&quot;&#x27;warning&#x27;&quot;</code> | @see [constructor parameters](/api-constructor#parameters) |
+| [images[].limitInputPixels] | <code>number</code> \| <code>boolean</code> | <code>268402689</code> | @see [constructor parameters](/api-constructor#parameters) |
+
+**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!
+  });
+```

docs/src/content/docs/api-constructor.md

@@ -0,0 +1,264 @@
+---
+# 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>&quot;&#x27;warning&#x27;&quot;</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.subifd] | <code>number</code> | <code>-1</code> | subIFD (Sub Image File Directory) to extract for OME-TIFF, defaults to main image. |
+| [options.level] | <code>number</code> | <code>0</code> | level to extract from a multi-level input (OpenSlide), zero based. |
+| [options.pdfBackground] | <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. Requires the use of a globally-installed libvips compiled with support for PDFium, Poppler, ImageMagick or GraphicsMagick. |
+| [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.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.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> |  | mean of pixels in generated noise. |
+| [options.create.noise.sigma] | <code>number</code> |  | standard deviation of pixels in 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>&quot;&#x27;left&#x27;&quot;</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>&quot;&#x27;word&#x27;&quot;</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>&quot;&#x27;left&#x27;&quot;</code> | horizontal alignment style for images joined horizontally (`'left'`, `'centre'`, `'center'`, `'right'`). |
+| [options.join.valign] | <code>string</code> | <code>&quot;&#x27;top&#x27;&quot;</code> | vertical alignment style for images joined vertically (`'top'`, `'centre'`, `'center'`, `'bottom'`). |
+
+**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) {}
+  });
+```

docs/src/content/docs/api-input.md

@@ -0,0 +1,138 @@
+---
+# This file was auto-generated from JSDoc in lib/input.js
+title: Input metadata
+---
+
+## metadata
+> metadata([callback]) ⇒ <code>Promise.&lt;Object&gt;</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#parameters).
+
+A `Promise` is returned when `callback` is not provided.
+
+- `format`: Name of decoder used to decompress image data e.g. `jpeg`, `png`, `webp`, `gif`, `svg`
+- `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/VipsImage.html#VipsInterpretation)
+- `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/VipsImage.html#VipsBandFormat)
+- `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
+- `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.&lt;Object&gt;</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();
+```

docs/src/content/docs/api-operation.md

@@ -0,0 +1,723 @@
+---
+# 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>&quot;\&quot;#000000\&quot;&quot;</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.&lt;Array.&lt;number&gt;&gt;</code> \| <code>Array.&lt;number&gt;</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>&quot;#000000&quot;</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/libvips-convolution.html#vips-sharpen) 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>&quot;&#x27;integer&#x27;&quot;</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>&quot;{r: 0, g: 0, b: 0}&quot;</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.&lt;number&gt;</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.&lt;number&gt;</code> | <code>[]</code> | multiplier |
+| [b] | <code>number</code> \| <code>Array.&lt;number&gt;</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.&lt;Array.&lt;number&gt;&gt;</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();
+```

docs/src/content/docs/api-output.md

@@ -0,0 +1,847 @@
+---
+# This file was auto-generated from JSDoc in lib/output.js
+title: Output options
+---
+
+## toFile
+> toFile(fileOut, [callback]) ⇒ <code>Promise.&lt;Object&gt;</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.&lt;Object&gt;</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.&lt;Buffer&gt;</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.&lt;Buffer&gt;</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.&lt;string, Object.&lt;string, string&gt;&gt;</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.&lt;string, Object.&lt;string, string&gt;&gt;</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.
+
+Where necessary, will attempt to convert the output colour space to match the profile.
+
+
+**Since**: 0.33.0  
+**Example**  
+```js
+const outputWithIccProfile = await sharp(inputWithIccProfile)
+  .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();
+```
+
+
+## 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>&quot;&#x27;4:2:0&#x27;&quot;</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>&quot;&#x27;default&#x27;&quot;</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.&lt;number&gt;</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.loop] | <code>number</code> | <code>0</code> | number of animation iterations, use 0 for infinite animation |
+| [options.delay] | <code>number</code> \| <code>Array.&lt;number&gt;</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](https://sharp.pixelplumbing.com/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>&quot;&#x27;4:4:4&#x27;&quot;</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>&quot;&#x27;jpeg&#x27;&quot;</code> | compression options: none, jpeg, deflate, packbits, ccittfax4, lzw, webp, zstd, jp2k |
+| [options.predictor] | <code>string</code> | <code>&quot;&#x27;horizontal&#x27;&quot;</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>&quot;&#x27;inch&#x27;&quot;</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.
+
+
+**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>&quot;&#x27;4:4:4&#x27;&quot;</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>&quot;&#x27;4:4:4&#x27;&quot;</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](https://sharp.pixelplumbing.com/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.&lt;number&gt;</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>&quot;&#x27;uchar&#x27;&quot;</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>&quot;{r: 255, g: 255, b: 255, alpha: 1}&quot;</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>&quot;&#x27;fs&#x27;&quot;</code> | tile container, with value `fs` (filesystem) or `zip` (compressed file). |
+| [options.layout] | <code>string</code> | <code>&quot;&#x27;dz&#x27;&quot;</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>&quot;&#x27;https://example.com/iiif&#x27;&quot;</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')) { ... }
+}
+```

docs/src/content/docs/api-resize.md

@@ -0,0 +1,321 @@
+---
+# 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).
+
+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>&#x27;cover&#x27;</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>&#x27;centre&#x27;</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>&#x27;lanczos3&#x27;</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>&#x27;background&#x27;</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>&quot;&#x27;top-left pixel&#x27;&quot;</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();
+```

docs/src/content/docs/api-utility.md

@@ -0,0 +1,238 @@
+---
+# 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>&quot;nearest&quot;</code> | [Nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation). Suitable for image enlargement only. |
+| bilinear | <code>string</code> | <code>&quot;bilinear&quot;</code> | [Bilinear interpolation](http://en.wikipedia.org/wiki/Bilinear_interpolation). Faster than bicubic but with less smooth results. |
+| bicubic | <code>string</code> | <code>&quot;bicubic&quot;</code> | [Bicubic interpolation](http://en.wikipedia.org/wiki/Bicubic_interpolation) (the default). |
+| locallyBoundedBicubic | <code>string</code> | <code>&quot;lbb&quot;</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>&quot;nohalo&quot;</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>&quot;vsqbs&quot;</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.
+
+The maximum number of images that sharp can process in parallel
+is controlled by libuv's `UV_THREADPOOL_SIZE` environment variable,
+which defaults to 4.
+
+https://nodejs.org/api/cli.html#uv_threadpool_sizesize
+
+For example, by default, a machine with 8 CPU cores will process
+4 images in parallel and use up to 8 threads per image,
+so there will be up to 32 concurrent threads.
+
+
+**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.&lt;string&gt;</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.&lt;string&gt;</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']
+});
+```

docs/src/content/docs/index.md

@@ -0,0 +1,98 @@
+---
+title: "High performance Node.js image processing"
+---
+
+<img src="/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, 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.
+
+```sh
+npm install sharp
+```
+
+## Formats
+
+This module supports reading JPEG, PNG, WebP, GIF, AVIF, TIFF and SVG images.
+
+Output images can be in JPEG, PNG, WebP, GIF, AVIF and TIFF formats as well as uncompressed raw pixel data.
+
+Streams, Buffer objects and the filesystem can be used for input and output.
+
+A single input Stream can be split into multiple processing pipelines and output Streams.
+
+Deep Zoom image pyramids can be generated,
+suitable for use with "slippy map" tile viewers like
+[OpenSeadragon](https://github.com/openseadragon/openseadragon).
+
+## Fast
+
+This module is powered by the blazingly fast
+[libvips](https://github.com/libvips/libvips) image processing library,
+originally created in 1989 at Birkbeck College
+and currently maintained by a small team led by
+[John Cupitt](https://github.com/jcupitt).
+
+Only small regions of uncompressed image data
+are held in memory and processed at a time,
+taking full advantage of multiple CPU cores and L1/L2/L3 cache.
+
+Everything remains non-blocking thanks to _libuv_,
+no child processes are spawned and Promises/async/await are supported.
+
+## Optimal
+
+The features of `mozjpeg` and `pngquant` can be used
+to optimise the file size of JPEG and PNG images respectively,
+without having to invoke separate `imagemin` processes.
+
+Huffman tables are optimised when generating JPEG output images
+without having to use separate command line tools like
+[jpegoptim](https://github.com/tjko/jpegoptim) and
+[jpegtran](http://jpegclub.org/jpegtran/).
+
+PNG filtering is disabled by default,
+which for diagrams and line art often produces the same result
+as [pngcrush](https://pmt.sourceforge.io/pngcrush/).
+
+The file size of animated GIF output is optimised
+without having to use separate command line tools such as
+[gifsicle](https://www.lcdf.org/gifsicle/).
+
+## 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.

docs/src/content/docs/install.md

@@ -0,0 +1,357 @@
+---
+title: Installation
+---
+
+Works with your choice of JavaScript package manager.
+
+:::caution
+Please ensure your package manager is configured to install optional dependencies
+:::
+
+If a package manager lockfile must support multiple platforms,
+please see the [cross-platform](#cross-platform) section
+to help decide which package manager is appropriate.
+
+```sh
+npm install sharp
+```
+
+```sh
+pnpm add sharp
+```
+
+When using `pnpm`, you may need to add `sharp` to
+[ignoredBuiltDependencies](https://pnpm.io/package_json#pnpmignoredbuiltdependencies)
+to silence warnings.
+
+```sh
+yarn add sharp
+```
+
+```sh
+bun add sharp
+```
+
+```sh
+deno run --allow-ffi ...
+```
+
+## Prerequisites
+
+* Node-API v9 compatible runtime e.g. Node.js ^18.17.0 or >=20.3.0.
+
+## Prebuilt binaries
+
+Ready-compiled sharp and libvips binaries are provided for use on the most common platforms:
+
+* macOS x64 (>= 10.15)
+* macOS ARM64
+* Linux ARM (glibc >= 2.31)
+* Linux ARM64 (glibc >= 2.26, musl >= 1.2.2)
+* Linux ppc64 (glibc >= 2.31)
+* Linux s390x (glibc >= 2.31)
+* Linux x64 (glibc >= 2.26, musl >= 1.2.2, CPU with SSE4.2)
+* Windows x64
+* Windows x86
+* Windows ARM64
+
+This provides support for the
+JPEG, PNG, WebP, AVIF (limited to 8-bit depth), TIFF, GIF and SVG (input) image formats.
+
+## Cross-platform
+
+At install time, package managers will automatically select prebuilt binaries
+for the current OS platform and CPU architecture, where available.
+
+Some package managers support multiple platforms and architectures
+within the same installation tree and/or using the same lockfile.
+
+### npm v10+
+
+:::caution
+npm `package-lock.json` files shared by multiple platforms can cause installation problems due to [npm bug #4828](https://github.com/npm/cli/issues/4828)
+:::
+
+Provides limited support via `--os`, `--cpu` and `--libc` flags.
+
+To support macOS with Intel x64 and ARM64 CPUs:
+```sh
+npm install --cpu=x64 --os=darwin sharp
+npm install --cpu=arm64 --os=darwin sharp
+```
+
+When the cross-target is Linux, the C standard library must be specified.
+
+To support glibc (e.g. Debian) and musl (e.g. Alpine) Linux with Intel x64 CPUs:
+```sh
+npm install --cpu=x64 --os=linux --libc=glibc sharp
+npm install --cpu=x64 --os=linux --libc=musl sharp
+```
+
+### yarn v3+
+
+Use the [supportedArchitectures](https://yarnpkg.com/configuration/yarnrc#supportedArchitectures) configuration.
+
+### pnpm v8+
+
+Use the [supportedArchitectures](https://pnpm.io/package_json#pnpmsupportedarchitectures) configuration.
+
+## Custom libvips
+
+To use a custom, globally-installed version of libvips instead of the provided binaries,
+make sure it is at least the version listed under `config.libvips` in the `package.json` file
+and that it can be located using `pkg-config --modversion vips-cpp`.
+
+For help compiling libvips and its dependencies, please see
+[building libvips from source](https://www.libvips.org/install.html#building-libvips-from-source).
+
+The use of a globally-installed libvips is unsupported on Windows
+and on macOS when running Node.js under Rosetta.
+
+## Building from source
+
+This module will be compiled from source at `npm install` time when:
+
+* a globally-installed libvips is detected, or
+* when the `npm install --build-from-source` flag is used.
+
+The logic to detect a globally-installed libvips can be skipped by setting the
+`SHARP_IGNORE_GLOBAL_LIBVIPS` (never try to use it) or
+`SHARP_FORCE_GLOBAL_LIBVIPS` (always try to use it, even when missing or outdated)
+environment variables.
+
+Building from source requires:
+
+* C++17 compiler
+* [node-addon-api](https://www.npmjs.com/package/node-addon-api) version 7+
+* [node-gyp](https://github.com/nodejs/node-gyp#installation) version 9+ and its dependencies
+
+There is an install-time check for these dependencies.
+If `node-addon-api` or `node-gyp` cannot be found, try adding them via:
+
+```sh
+npm install --save node-addon-api node-gyp
+```
+
+When using `pnpm`, you may need to add `sharp` to
+[onlyBuiltDependencies](https://pnpm.io/package_json#pnpmonlybuiltdependencies)
+to ensure the installation script can be run.
+
+For cross-compiling, the `--platform`, `--arch` and `--libc` npm flags
+(or the `npm_config_platform`, `npm_config_arch` and `npm_config_libc` environment variables)
+can be used to configure the target environment.
+
+## WebAssembly
+
+Experimental support is provided for runtime environments that provide
+multi-threaded Wasm via Workers.
+
+Use in web browsers is unsupported.
+
+Native text rendering is unsupported.
+
+[Tile-based output](/api-output#tile) is unsupported.
+
+```sh
+npm install --cpu=wasm32 sharp
+```
+
+## FreeBSD
+
+The `vips` package must be installed before `npm install` is run.
+
+```sh
+pkg install -y pkgconf vips
+```
+
+```sh
+cd /usr/ports/graphics/vips/ && make install clean
+```
+
+## Linux memory allocator
+
+The default memory allocator on most glibc-based Linux systems
+(e.g. Debian, Red Hat) is unsuitable for long-running, multi-threaded
+processes that involve lots of small memory allocations.
+
+For this reason, by default, sharp will limit the use of thread-based
+[concurrency](api-utility#concurrency) when the glibc allocator is
+detected at runtime.
+
+To help avoid fragmentation and improve performance on these systems,
+the use of an alternative memory allocator such as
+[jemalloc](https://github.com/jemalloc/jemalloc) is recommended.
+
+Those using musl-based Linux (e.g. Alpine) and non-Linux systems are
+unaffected.
+
+## AWS Lambda
+
+The `node_modules` directory of the
+[deployment package](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-package.html)
+must include binaries for either the linux-x64 or linux-arm64 platforms
+depending on the chosen architecture.
+
+When building your deployment package on a machine that differs from the target architecture,
+see the [cross-platform](#cross-platform) section to help decide which package manager is appropriate
+and how to configure it.
+
+Some package managers use symbolic links
+but AWS Lambda does not support these within deployment packages.
+
+To get the best performance select the largest memory available.
+A 1536 MB function provides ~12x more CPU time than a 128 MB function.
+
+When integrating with AWS API Gateway, ensure it is configured with the relevant
+[binary media types](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings.html).
+
+## Bundlers
+
+### webpack
+
+Ensure sharp is excluded from bundling via the
+[externals](https://webpack.js.org/configuration/externals/)
+configuration.
+
+```js
+externals: {
+  'sharp': 'commonjs sharp'
+}
+```
+
+### esbuild
+
+Ensure sharp is excluded from bundling via the
+[external](https://esbuild.github.io/api/#external)
+configuration.
+
+```js
+buildSync({
+  entryPoints: ['app.js'],
+  bundle: true,
+  platform: 'node',
+  external: ['sharp'],
+})
+```
+
+```sh
+esbuild app.js --bundle --platform=node --external:sharp
+```
+
+For `serverless-esbuild`, ensure platform-specific binaries are installed
+via the `serverless.yml` configuration.
+
+```yaml
+custom:
+  esbuild:
+    external:
+      - sharp
+    packagerOptions:
+      scripts:
+        - npm install --os=linux --cpu=x64 sharp
+```
+
+### electron
+
+#### electron-builder
+
+Ensure `sharp` is unpacked from the ASAR archive file using the
+[asarUnpack](https://www.electron.build/app-builder-lib.interface.platformspecificbuildoptions#asarunpack)
+option.
+
+```json
+{
+  "build": {
+    "asar": true,
+    "asarUnpack": [
+      "**/node_modules/sharp/**/*",
+      "**/node_modules/@img/**/*"
+    ]
+  }
+}
+```
+
+#### electron-forge
+
+Ensure `sharp` is unpacked from the ASAR archive file using the
+[unpack](https://js.electronforge.io/interfaces/_electron_forge_maker_squirrel.InternalOptions.Options.html#asar)
+option.
+
+```json
+{
+  "packagerConfig": {
+    "asar": {
+      "unpack": "**/node_modules/{sharp,@img}/**/*"
+    }
+  }
+}
+```
+
+When using `electron-forge` with [Webpack](#webpack),
+you may also need to add
+[forge-externals-plugin](https://www.npmjs.com/package/@timfish/forge-externals-plugin).
+
+### vite
+
+Ensure `sharp` is excluded from bundling via the
+[build.rollupOptions](https://vitejs.dev/config/build-options.html)
+configuration.
+
+```js
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  build: {
+    rollupOptions: {
+      external: [
+        "sharp"
+      ]
+    }
+  }
+});
+```
+
+## TypeScript
+
+TypeScript definitions are published as part of
+the `sharp` package from v0.32.0.
+
+Previously these were available via the `@types/sharp` package,
+which is now deprecated.
+
+When using Typescript, please ensure `devDependencies` includes
+the `@types/node` package.
+
+## Fonts
+
+When creating text images or rendering SVG images that contain text elements,
+`fontconfig` is used to find the relevant fonts.
+
+On Windows and macOS systems, all system fonts are available for use.
+
+On macOS systems using Homebrew, you may need to set the
+`PANGOCAIRO_BACKEND` environment variable to a value of `fontconfig`
+to ensure it is used for font discovery instead of Core Text.
+
+On Linux systems, fonts that include the relevant
+[`fontconfig` configuration](https://www.freedesktop.org/software/fontconfig/fontconfig-user.html)
+when installed via package manager are available for use.
+
+If `fontconfig` configuration is not found, the following error will occur:
+```
+Fontconfig error: Cannot load default config file
+```
+
+In serverless environments where there is no control over font packages,
+use the `FONTCONFIG_PATH` environment variable to point to a custom location.
+
+Embedded SVG fonts are unsupported.
+
+## Known conflicts
+
+### Canvas and Windows
+
+If both `canvas` and `sharp` modules are used in the same Windows process, the following error may occur:
+```
+The specified procedure could not be found.
+```

docs/src/content/docs/performance.md

@@ -0,0 +1,103 @@
+---
+title: Performance
+---
+
+A test to benchmark the performance of this module relative to alternatives.
+
+Greater libvips performance can be expected with caching enabled (default)
+and using 8+ core machines, especially those with larger L1/L2 CPU caches.
+
+The I/O limits of the relevant (de)compression library will generally determine maximum throughput.
+
+## Contenders
+
+* [jimp](https://www.npmjs.com/package/jimp) v1.6.0 - Image processing in pure JavaScript.
+* [imagemagick](https://www.npmjs.com/package/imagemagick) v0.1.3 - Supports filesystem only and "*has been unmaintained for a long time*".
+* [gm](https://www.npmjs.com/package/gm) v1.25.1 - Fully featured wrapper around GraphicsMagick's `gm` command line utility, but "*has been sunset*".
+* sharp v0.34.0 / libvips v8.16.1 - Caching within libvips disabled to ensure a fair comparison.
+
+## Environment
+
+### AMD64
+
+* AWS EC2 us-west-2 [c7a.xlarge](https://aws.amazon.com/ec2/instance-types/c7a/) (4x AMD EPYC 9R14)
+* Ubuntu 24.10 [fad5ba7223f8](https://hub.docker.com/layers/library/ubuntu/24.10/images/sha256-fad5ba7223f8d87179dfa23211d31845d47e07a474ac31ad5258afb606523c0d)
+* Node.js 22.14.0
+
+### ARM64
+
+* AWS EC2 us-west-2 [c8g.xlarge](https://aws.amazon.com/ec2/instance-types/c8g/) (4x ARM Graviton4)
+* Ubuntu 24.10 [133f2e05cb69](https://hub.docker.com/layers/library/ubuntu/24.10/images/sha256-133f2e05cb6958c3ce7ec870fd5a864558ba780fb7062315b51a23670bff7e76)
+* Node.js 22.14.0
+
+## Task: JPEG
+
+Decompress a 2725x2225 JPEG image,
+resize to 720x588 using Lanczos 3 resampling (where available),
+then compress to JPEG at a "quality" setting of 80.
+
+Note: jimp does not support Lanczos 3, bicubic resampling used instead.
+
+#### Results: JPEG (AMD64)
+
+| Module             | Input  | Output | Ops/sec | Speed-up |
+| :----------------- | :----- | :----- | ------: | -------: |
+| jimp               | buffer | buffer |    2.35 |      1.0 |
+| imagemagick        | file   | file   |   10.51 |      4.5 |
+| gm                 | buffer | buffer |   11.67 |      5.0 |
+| gm                 | file   | file   |   11.75 |      5.1 |
+| sharp              | stream | stream |   60.72 |     25.8 |
+| sharp              | file   | file   |   62.37 |     26.5 |
+| sharp              | buffer | buffer |   65.15 |     27.7 |
+
+#### Results: JPEG (ARM64)
+
+| Module             | Input  | Output | Ops/sec | Speed-up |
+| :----------------- | :----- | :----- | ------: | -------: |
+| jimp               | buffer | buffer |    2.13 |      1.0 |
+| imagemagick        | file   | file   |   12.95 |      6.1 |
+| gm                 | buffer | buffer |   13.53 |      6.4 |
+| gm                 | file   | file   |   13.52 |      6.4 |
+| sharp              | stream | stream |   46.58 |     21.9 |
+| sharp              | file   | file   |   48.42 |     22.7 |
+| sharp              | buffer | buffer |   50.16 |     23.6 |
+
+## Task: PNG
+
+Decompress a 2048x1536 RGBA PNG image,
+premultiply the alpha channel,
+resize to 720x540 using Lanczos 3 resampling (where available),
+unpremultiply then compress as PNG with a "default" zlib compression level of 6
+and without adaptive filtering.
+
+Note: jimp does not support premultiply/unpremultiply.
+
+### Results: PNG (AMD64)
+
+| Module             | Input  | Output | Ops/sec | Speed-up |
+| :----------------- | :----- | :----- | ------: | -------: |
+| gm                 | file   | file   |    8.66 |      1.0 |
+| imagemagick        | file   | file   |    8.79 |      1.0 |
+| jimp               | buffer | buffer |   11.26 |      1.3 |
+| sharp              | file   | file   |   27.93 |      3.2 |
+| sharp              | buffer | buffer |   28.69 |      3.3 |
+
+### Results: PNG (ARM64)
+
+| Module             | Input  | Output | Ops/sec | Speed-up |
+| :----------------- | :----- | :----- | ------: | -------: |
+| gm                 | file   | file   |    9.65 |      1.0 |
+| imagemagick        | file   | file   |    9.72 |      1.0 |
+| jimp               | buffer | buffer |   10.68 |      1.1 |
+| sharp              | file   | file   |   23.90 |      2.5 |
+| sharp              | buffer | buffer |   24.48 |      2.5 |
+
+## Running the benchmark test
+
+Requires Docker.
+
+```sh
+git clone https://github.com/lovell/sharp.git
+cd sharp/test/bench
+./run-with-docker.sh
+```

docs/src/styles/custom.css

@@ -0,0 +1,45 @@
+@view-transition {
+  navigation: auto;
+}
+
+:root {
+  --sl-content-width: 60rem;
+  --sl-color-accent-low: #072d00;
+  --sl-color-accent: #247f00;
+  --sl-color-accent-high: #aad7a0;
+  --sl-color-white: #ffffff;
+  --sl-color-gray-1: #eaf0e8;
+  --sl-color-gray-2: #c5cdc3;
+  --sl-color-gray-3: #99a796;
+  --sl-color-gray-4: #4f5c4d;
+  --sl-color-gray-5: #303c2d;
+  --sl-color-gray-6: #1f2a1c;
+  --sl-color-black: #151a13;
+}
+
+:root[data-theme="light"] {
+  --sl-color-accent-low: #c0e2b8;
+  --sl-color-accent: #165800;
+  --sl-color-accent-high: #0d3e00;
+  --sl-color-white: #151a13;
+  --sl-color-gray-1: #1f2a1c;
+  --sl-color-gray-2: #303c2d;
+  --sl-color-gray-3: #4f5c4d;
+  --sl-color-gray-4: #82907f;
+  --sl-color-gray-5: #bdc4bb;
+  --sl-color-gray-6: #eaf0e8;
+  --sl-color-gray-7: #f4f7f3;
+  --sl-color-black: #ffffff;
+}
+
+blockquote {
+  background-color: var(--sl-color-gray-6);
+  padding: 1rem;
+}
+
+.site-title::after {
+  content: "High performance Node.js image processing";
+  color: var(--sl-color-text);
+  font-size: var(--sl-text-sm);
+  padding-top: 0.3rem;
+}

docs/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "astro/tsconfigs/strict",
+  "include": [".astro/types.d.ts", "**/*"],
+  "exclude": ["dist"]
+}

install/check.js

@@ -0,0 +1,41 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
+'use strict';
+
+try {
+  const { useGlobalLibvips, globalLibvipsVersion, log, spawnRebuild } = require('../lib/libvips');
+
+  const buildFromSource = (msg) => {
+    log(msg);
+    log('Attempting to build from source via node-gyp');
+    try {
+      const addonApi = require('node-addon-api');
+      log(`Found node-addon-api ${addonApi.version || ''}`);
+    } catch (err) {
+      log('Please add node-addon-api to your dependencies');
+      return;
+    }
+    try {
+      const gyp = require('node-gyp');
+      log(`Found node-gyp ${gyp().version}`);
+    } catch (err) {
+      log('Please add node-gyp to your dependencies');
+      return;
+    }
+    log('See https://sharp.pixelplumbing.com/install#building-from-source');
+    const status = spawnRebuild();
+    if (status !== 0) {
+      process.exit(status);
+    }
+  };
+
+  if (useGlobalLibvips(log)) {
+    buildFromSource(`Detected globally-installed libvips v${globalLibvipsVersion()}`);
+  } else if (process.env.npm_config_build_from_source) {
+    buildFromSource('Detected --build-from-source flag');
+  }
+} catch (err) {
+  const summary = err.message.split(/\n/).slice(0, 1);
+  console.log(`sharp: skipping install check: ${summary}`);
+}

lib/channel.js

@@ -1,3 +1,6 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
 'use strict';
 
 const is = require('./is');
@@ -12,33 +15,91 @@ const bool = {
   eor: 'eor'
 };
 
+/**
+ * Remove alpha channels, if any. This is a no-op if the image does not have an alpha channel.
+ *
+ * See also {@link /api-operation#flatten|flatten}.
+ *
+ * @example
+ * sharp('rgba.png')
+ *   .removeAlpha()
+ *   .toFile('rgb.png', function(err, info) {
+ *     // rgb.png is a 3 channel image without an alpha channel
+ *   });
+ *
+ * @returns {Sharp}
+ */
+function removeAlpha () {
+  this.options.removeAlpha = true;
+  return this;
+}
+
+/**
+ * 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.
+ *
+ * @since 0.21.2
+ *
+ * @example
+ * // rgba.png will be a 4 channel image with a fully-opaque alpha channel
+ * await sharp('rgb.jpg')
+ *   .ensureAlpha()
+ *   .toFile('rgba.png')
+ *
+ * @example
+ * // rgba is a 4 channel image with a fully-transparent alpha channel
+ * const rgba = await sharp(rgb)
+ *   .ensureAlpha(0)
+ *   .toBuffer();
+ *
+ * @param {number} [alpha=1] - alpha transparency level (0=fully-transparent, 1=fully-opaque)
+ * @returns {Sharp}
+ * @throws {Error} Invalid alpha transparency level
+ */
+function ensureAlpha (alpha) {
+  if (is.defined(alpha)) {
+    if (is.number(alpha) && is.inRange(alpha, 0, 1)) {
+      this.options.ensureAlpha = alpha;
+    } else {
+      throw is.invalidParameterError('alpha', 'number between 0 and 1', alpha);
+    }
+  } else {
+    this.options.ensureAlpha = 1;
+  }
+  return this;
+}
+
 /**
  * Extract a single channel from a multi-channel image.
  *
  * @example
- * sharp(input)
+ * // green.jpg is a greyscale image containing the green channel of the input
+ * await sharp(input)
  *   .extractChannel('green')
- *   .toFile('input_green.jpg', function(err, info) {
- *     // info.channels === 1
- *     // input_green.jpg contains the green channel of the input image
- *    });
+ *   .toFile('green.jpg');
  *
- * @param {Number|String} channel - zero-indexed band number to extract, or `red`, `green` or `blue` as alternative to `0`, `1` or `2` respectively.
+ * @example
+ * // red1 is the red value of the first pixel, red2 the second pixel etc.
+ * const [red1, red2, ...] = await sharp(input)
+ *   .extractChannel(0)
+ *   .raw()
+ *   .toBuffer();
+ *
+ * @param {number|string} channel - zero-indexed channel/band number to extract, or `red`, `green`, `blue` or `alpha`.
  * @returns {Sharp}
  * @throws {Error} Invalid channel
  */
 function extractChannel (channel) {
-  if (channel === 'red') {
-    channel = 0;
-  } else if (channel === 'green') {
-    channel = 1;
-  } else if (channel === 'blue') {
-    channel = 2;
+  const channelMap = { red: 0, green: 1, blue: 2, alpha: 3 };
+  if (Object.keys(channelMap).includes(channel)) {
+    channel = channelMap[channel];
   }
   if (is.integer(channel) && is.inRange(channel, 0, 4)) {
     this.options.extractChannel = channel;
   } else {
-    throw new Error('Cannot extract invalid channel ' + channel);
+    throw is.invalidParameterError('channel', 'integer or one of: red, green, blue, alpha', channel);
   }
   return this;
 }
@@ -51,10 +112,10 @@ function extractChannel (channel) {
  * - 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: JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data.
+ * 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.
  *
- * @param {Array<String|Buffer>|String|Buffer} images - one or more images (file paths, Buffers).
+ * @param {Array<string|Buffer>|string|Buffer} images - one or more images (file paths, Buffers).
  * @param {Object} options - image options, see `sharp()` constructor.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
@@ -82,7 +143,7 @@ function joinChannel (images, options) {
  *     // then `O(1,1) = 0b11110111 & 0b10101010 & 0b00001111 = 0b00000010 = 2`.
  *   });
  *
- * @param {String} boolOp - one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
+ * @param {string} boolOp - one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
@@ -90,23 +151,24 @@ function bandbool (boolOp) {
   if (is.string(boolOp) && is.inArray(boolOp, ['and', 'or', 'eor'])) {
     this.options.bandBoolOp = boolOp;
   } else {
-    throw new Error('Invalid bandbool operation ' + boolOp);
+    throw is.invalidParameterError('boolOp', 'one of: and, or, eor', boolOp);
   }
   return this;
 }
 
 /**
  * Decorate the Sharp prototype with channel-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {
-  // Public instance functions
-  [
+  Object.assign(Sharp.prototype, {
+    // Public instance functions
+    removeAlpha,
+    ensureAlpha,
     extractChannel,
     joinChannel,
     bandbool
-  ].forEach(function (f) {
-    Sharp.prototype[f.name] = f;
   });
   // Class attributes
   Sharp.bool = bool;

lib/colour.js

@@ -1,3 +1,6 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
 'use strict';
 
 const color = require('color');
@@ -16,35 +19,34 @@ const colourspace = {
 };
 
 /**
- * Set the background for the `embed`, `flatten` and `extend` operations.
- * The default background is `{r: 0, g: 0, b: 0, alpha: 1}`, black without transparency.
+ * Tint the image using the provided colour.
+ * An alpha channel may be present and will be unchanged by the operation.
  *
- * Delegates to the _color_ module, which can throw an Error
- * but is liberal in what it accepts, clipping values to sensible min/max.
- * The alpha value is a float between `0` (transparent) and `1` (opaque).
+ * @example
+ * const output = await sharp(input)
+ *   .tint({ r: 255, g: 240, b: 16 })
+ *   .toBuffer();
  *
- * @param {String|Object} rgba - parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
+ * @param {string|Object} tint - Parsed by the [color](https://www.npmjs.org/package/color) module.
  * @returns {Sharp}
  * @throws {Error} Invalid parameter
  */
-function background (rgba) {
-  const colour = color(rgba);
-  this.options.background = [
-    colour.red(),
-    colour.green(),
-    colour.blue(),
-    Math.round(colour.alpha() * 255)
-  ];
+function tint (tint) {
+  this._setBackgroundColourOption('tint', tint);
   return this;
 }
 
 /**
  * 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) color channels.
+ * 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 color channel.
+ * which will produce an output image containing one colour channel.
  * An alpha channel may be present, and will be unchanged by the operation.
+ *
+ * @example
+ * const output = await sharp(input).greyscale().toBuffer();
+ *
  * @param {Boolean} [greyscale=true]
  * @returns {Sharp}
  */
@@ -62,16 +64,61 @@ function grayscale (grayscale) {
   return this.greyscale(grayscale);
 }
 
+/**
+ * Set the pipeline colourspace.
+ *
+ * The input image will be converted to the provided colourspace at the start of the pipeline.
+ * All operations will use this colourspace before converting to the output colourspace,
+ * as defined by {@link #tocolourspace|toColourspace}.
+ *
+ * @since 0.29.0
+ *
+ * @example
+ * // 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')
+ *
+ * @param {string} [colourspace] - pipeline colourspace e.g. `rgb16`, `scrgb`, `lab`, `grey16` [...](https://github.com/libvips/libvips/blob/41cff4e9d0838498487a00623462204eb10ee5b8/libvips/iofuncs/enumtypes.c#L774)
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function pipelineColourspace (colourspace) {
+  if (!is.string(colourspace)) {
+    throw is.invalidParameterError('colourspace', 'string', colourspace);
+  }
+  this.options.colourspacePipeline = colourspace;
+  return this;
+}
+
+/**
+ * Alternative spelling of `pipelineColourspace`.
+ * @param {string} [colorspace] - pipeline colorspace.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function pipelineColorspace (colorspace) {
+  return this.pipelineColourspace(colorspace);
+}
+
 /**
  * Set the output colourspace.
  * By default output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.
- * @param {String} [colourspace] - output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568)
+ *
+ * @example
+ * // Output 16 bits per pixel RGB
+ * await sharp(input)
+ *  .toColourspace('rgb16')
+ *  .toFile('16-bpp.png')
+ *
+ * @param {string} [colourspace] - output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/libvips/libvips/blob/3c0bfdf74ce1dc37a6429bed47fa76f16e2cd70a/libvips/iofuncs/enumtypes.c#L777-L794)
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
 function toColourspace (colourspace) {
   if (!is.string(colourspace)) {
-    throw new Error('Invalid output colourspace ' + colourspace);
+    throw is.invalidParameterError('colourspace', 'string', colourspace);
   }
   this.options.colourspace = colourspace;
   return this;
@@ -79,7 +126,7 @@ function toColourspace (colourspace) {
 
 /**
  * Alternative spelling of `toColourspace`.
- * @param {String} [colorspace] - output colorspace.
+ * @param {string} [colorspace] - output colorspace.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
@@ -87,20 +134,57 @@ function toColorspace (colorspace) {
   return this.toColourspace(colorspace);
 }
 
+/**
+ * Create a RGBA colour array from a given value.
+ * @private
+ * @param {string|Object} value
+ * @throws {Error} Invalid value
+ */
+function _getBackgroundColourOption (value) {
+  if (is.object(value) || is.string(value)) {
+    const colour = color(value);
+    return [
+      colour.red(),
+      colour.green(),
+      colour.blue(),
+      Math.round(colour.alpha() * 255)
+    ];
+  } else {
+    throw is.invalidParameterError('background', 'object or string', value);
+  }
+}
+
+/**
+ * Update a colour attribute of the this.options Object.
+ * @private
+ * @param {string} key
+ * @param {string|Object} value
+ * @throws {Error} Invalid value
+ */
+function _setBackgroundColourOption (key, value) {
+  if (is.defined(value)) {
+    this.options[key] = _getBackgroundColourOption(value);
+  }
+}
+
 /**
  * Decorate the Sharp prototype with colour-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {
-  // Public instance functions
-  [
-    background,
+  Object.assign(Sharp.prototype, {
+    // Public
+    tint,
     greyscale,
     grayscale,
+    pipelineColourspace,
+    pipelineColorspace,
     toColourspace,
-    toColorspace
-  ].forEach(function (f) {
-    Sharp.prototype[f.name] = f;
+    toColorspace,
+    // Private
+    _getBackgroundColourOption,
+    _setBackgroundColourOption
   });
   // Class attributes
   Sharp.colourspace = colourspace;

lib/composite.js

@@ -1,26 +1,90 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
 'use strict';
 
 const is = require('./is');
 
 /**
- * Overlay (composite) an image over the processed (resized, extracted etc.) image.
+ * Blend modes.
+ * @member
+ * @private
+ */
+const blend = {
+  clear: 'clear',
+  source: 'source',
+  over: 'over',
+  in: 'in',
+  out: 'out',
+  atop: 'atop',
+  dest: 'dest',
+  'dest-over': 'dest-over',
+  'dest-in': 'dest-in',
+  'dest-out': 'dest-out',
+  'dest-atop': 'dest-atop',
+  xor: 'xor',
+  add: 'add',
+  saturate: 'saturate',
+  multiply: 'multiply',
+  screen: 'screen',
+  overlay: 'overlay',
+  darken: 'darken',
+  lighten: 'lighten',
+  'colour-dodge': 'colour-dodge',
+  'color-dodge': 'colour-dodge',
+  'colour-burn': 'colour-burn',
+  'color-burn': 'colour-burn',
+  'hard-light': 'hard-light',
+  'soft-light': 'soft-light',
+  difference: 'difference',
+  exclusion: 'exclusion'
+};
+
+/**
+ * Composite image(s) over the processed (resized, extracted etc.) image.
  *
- * The overlay image must be the same size or smaller than the processed 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`.
  *
- * If the overlay image contains an alpha channel then composition with premultiplication will occur.
+ * 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/libvips-conversion.html#VipsBlendMode
+ * and https://www.cairographics.org/operators/
+ *
+ * @since 0.22.0
+ *
+ * @example
+ * await sharp(background)
+ *   .composite([
+ *     { input: layer1, gravity: 'northwest' },
+ *     { input: layer2, gravity: 'southeast' },
+ *   ])
+ *   .toFile('combined.png');
+ *
+ * @example
+ * const output = await sharp('input.gif', { animated: true })
+ *   .composite([
+ *     { input: 'overlay.png', tile: true, blend: 'saturate' }
+ *   ])
+ *   .toBuffer();
  *
  * @example
  * sharp('input.png')
  *   .rotate(180)
  *   .resize(300)
- *   .flatten()
- *   .background('#ff6600')
- *   .overlayWith('overlay.png', { gravity: sharp.gravity.southeast } )
+ *   .flatten( { background: '#ff6600' } )
+ *   .composite([{ input: 'overlay.png', gravity: 'southeast' }])
  *   .sharpen()
  *   .withMetadata()
- *   .quality(90)
- *   .webp()
+ *   .webp( { quality: 90 } )
  *   .toBuffer()
  *   .then(function(outputBuffer) {
  *     // outputBuffer contains upside down, 300px wide, alpha channel flattened
@@ -28,70 +92,121 @@ const is = require('./is');
  *     // sharpened, with metadata, 90% quality WebP image data. Phew!
  *   });
  *
- * @param {(Buffer|String)} overlay - Buffer containing image data or String containing the path to an image file.
- * @param {Object} [options]
- * @param {String} [options.gravity='centre'] - gravity at which to place the overlay.
- * @param {Number} [options.top] - the pixel offset from the top edge.
- * @param {Number} [options.left] - the pixel offset from the left edge.
- * @param {Boolean} [options.tile=false] - set to true to repeat the overlay image across the entire image with the given `gravity`.
- * @param {Boolean} [options.cutout=false] - set to true to apply only the alpha channel of the overlay image to the input image, giving the appearance of one image being cut out of another.
- * @param {Number} [options.density=72] - integral number representing the DPI for vector overlay image.
- * @param {Object} [options.raw] - describes overlay when using raw pixel data.
- * @param {Number} [options.raw.width]
- * @param {Number} [options.raw.height]
- * @param {Number} [options.raw.channels]
- * @param {Object} [options.create] - describes a blank overlay to be created.
- * @param {Number} [options.create.width]
- * @param {Number} [options.create.height]
- * @param {Number} [options.create.channels] - 3-4
- * @param {String|Object} [options.create.background] - parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
+ * @param {Object[]} images - Ordered list of images to composite
+ * @param {Buffer|String} [images[].input] - Buffer containing image data, String containing the path to an image file, or Create object (see below)
+ * @param {Object} [images[].input.create] - describes a blank overlay to be created.
+ * @param {Number} [images[].input.create.width]
+ * @param {Number} [images[].input.create.height]
+ * @param {Number} [images[].input.create.channels] - 3-4
+ * @param {String|Object} [images[].input.create.background] - parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
+ * @param {Object} [images[].input.text] - describes a new text image to be created.
+ * @param {string} [images[].input.text.text] - text to render as a UTF-8 string. It can contain Pango markup, for example `<i>Le</i>Monde`.
+ * @param {string} [images[].input.text.font] - font name to render with.
+ * @param {string} [images[].input.text.fontfile] - absolute filesystem path to a font file that can be used by `font`.
+ * @param {number} [images[].input.text.width=0] - integral number of pixels to word-wrap at. Lines of text wider than this will be broken at word boundaries.
+ * @param {number} [images[].input.text.height=0] - 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.
+ * @param {string} [images[].input.text.align='left'] - text alignment (`'left'`, `'centre'`, `'center'`, `'right'`).
+ * @param {boolean} [images[].input.text.justify=false] - set this to true to apply justification to the text.
+ * @param {number} [images[].input.text.dpi=72] - the resolution (size) at which to render the text. Does not take effect if `height` is specified.
+ * @param {boolean} [images[].input.text.rgba=false] - 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>`.
+ * @param {number} [images[].input.text.spacing=0] - text line height in points. Will use the font line height if none is specified.
+ * @param {Boolean} [images[].autoOrient=false] - set to true to use EXIF orientation data, if present, to orient the image.
+ * @param {String} [images[].blend='over'] - how to blend this image with the image below.
+ * @param {String} [images[].gravity='centre'] - gravity at which to place the overlay.
+ * @param {Number} [images[].top] - the pixel offset from the top edge.
+ * @param {Number} [images[].left] - the pixel offset from the left edge.
+ * @param {Boolean} [images[].tile=false] - set to true to repeat the overlay image across the entire image with the given `gravity`.
+ * @param {Boolean} [images[].premultiplied=false] - set to true to avoid premultiplying the image below. Equivalent to the `--premultiplied` vips option.
+ * @param {Number} [images[].density=72] - number representing the DPI for vector overlay image.
+ * @param {Object} [images[].raw] - describes overlay when using raw pixel data.
+ * @param {Number} [images[].raw.width]
+ * @param {Number} [images[].raw.height]
+ * @param {Number} [images[].raw.channels]
+ * @param {boolean} [images[].animated=false] - Set to `true` to read all frames/pages of an animated image.
+ * @param {string} [images[].failOn='warning'] - @see {@link /api-constructor#parameters|constructor parameters}
+ * @param {number|boolean} [images[].limitInputPixels=268402689] - @see {@link /api-constructor#parameters|constructor parameters}
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-function overlayWith (overlay, options) {
-  this.options.overlay = this._createInputDescriptor(overlay, options, {
-    allowStream: false
-  });
-  if (is.object(options)) {
-    if (is.defined(options.tile)) {
-      if (is.bool(options.tile)) {
-        this.options.overlayTile = options.tile;
-      } else {
-        throw new Error('Invalid overlay tile ' + options.tile);
-      }
-    }
-    if (is.defined(options.cutout)) {
-      if (is.bool(options.cutout)) {
-        this.options.overlayCutout = options.cutout;
-      } else {
-        throw new Error('Invalid overlay cutout ' + options.cutout);
-      }
-    }
-    if (is.defined(options.left) || is.defined(options.top)) {
-      if (is.integer(options.left) && options.left >= 0 && is.integer(options.top) && options.top >= 0) {
-        this.options.overlayXOffset = options.left;
-        this.options.overlayYOffset = options.top;
-      } else {
-        throw new Error('Invalid overlay left ' + options.left + ' and/or top ' + options.top);
-      }
-    }
-    if (is.defined(options.gravity)) {
-      if (is.integer(options.gravity) && is.inRange(options.gravity, 0, 8)) {
-        this.options.overlayGravity = options.gravity;
-      } else if (is.string(options.gravity) && is.integer(this.constructor.gravity[options.gravity])) {
-        this.options.overlayGravity = this.constructor.gravity[options.gravity];
-      } else {
-        throw new Error('Unsupported overlay gravity ' + options.gravity);
-      }
-    }
+function composite (images) {
+  if (!Array.isArray(images)) {
+    throw is.invalidParameterError('images to composite', 'array', images);
   }
+  this.options.composite = images.map(image => {
+    if (!is.object(image)) {
+      throw is.invalidParameterError('image to composite', 'object', image);
+    }
+    const inputOptions = this._inputOptionsFromObject(image);
+    const composite = {
+      input: this._createInputDescriptor(image.input, inputOptions, { allowStream: false }),
+      blend: 'over',
+      tile: false,
+      left: 0,
+      top: 0,
+      hasOffset: false,
+      gravity: 0,
+      premultiplied: false
+    };
+    if (is.defined(image.blend)) {
+      if (is.string(blend[image.blend])) {
+        composite.blend = blend[image.blend];
+      } else {
+        throw is.invalidParameterError('blend', 'valid blend name', image.blend);
+      }
+    }
+    if (is.defined(image.tile)) {
+      if (is.bool(image.tile)) {
+        composite.tile = image.tile;
+      } else {
+        throw is.invalidParameterError('tile', 'boolean', image.tile);
+      }
+    }
+    if (is.defined(image.left)) {
+      if (is.integer(image.left)) {
+        composite.left = image.left;
+      } else {
+        throw is.invalidParameterError('left', 'integer', image.left);
+      }
+    }
+    if (is.defined(image.top)) {
+      if (is.integer(image.top)) {
+        composite.top = image.top;
+      } else {
+        throw is.invalidParameterError('top', 'integer', image.top);
+      }
+    }
+    if (is.defined(image.top) !== is.defined(image.left)) {
+      throw new Error('Expected both left and top to be set');
+    } else {
+      composite.hasOffset = is.integer(image.top) && is.integer(image.left);
+    }
+    if (is.defined(image.gravity)) {
+      if (is.integer(image.gravity) && is.inRange(image.gravity, 0, 8)) {
+        composite.gravity = image.gravity;
+      } else if (is.string(image.gravity) && is.integer(this.constructor.gravity[image.gravity])) {
+        composite.gravity = this.constructor.gravity[image.gravity];
+      } else {
+        throw is.invalidParameterError('gravity', 'valid gravity', image.gravity);
+      }
+    }
+    if (is.defined(image.premultiplied)) {
+      if (is.bool(image.premultiplied)) {
+        composite.premultiplied = image.premultiplied;
+      } else {
+        throw is.invalidParameterError('premultiplied', 'boolean', image.premultiplied);
+      }
+    }
+    return composite;
+  });
   return this;
 }
 
 /**
  * Decorate the Sharp prototype with composite-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {
-  Sharp.prototype.overlayWith = overlayWith;
+  Sharp.prototype.composite = composite;
+  Sharp.blend = blend;
 };

lib/constructor.js

@@ -1,43 +1,36 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
 'use strict';
 
-const path = require('path');
-const util = require('util');
-const stream = require('stream');
-const events = require('events');
-const semver = require('semver');
+const util = require('node:util');
+const stream = require('node:stream');
 const is = require('./is');
-const sharp = require('../build/Release/sharp.node');
 
-// Versioning
-let versions = {
-  vips: sharp.libvipsVersion()
-};
-(function () {
-  // Does libvips meet minimum requirement?
-  const libvipsVersionMin = require('../package.json').config.libvips;
-  /* istanbul ignore if */
-  if (semver.lt(versions.vips, libvipsVersionMin)) {
-    throw new Error('Found libvips ' + versions.vips + ' but require at least ' + libvipsVersionMin);
-  }
-  // Include versions of dependencies, if present
-  try {
-    versions = require('../vendor/lib/versions.json');
-  } catch (err) {}
-})();
+require('./sharp');
 
 // Use NODE_DEBUG=sharp to enable libvips warnings
 const debuglog = util.debuglog('sharp');
 
 /**
- * @class Sharp
- *
  * Constructor factory to create an instance of `sharp`, to which further methods are chained.
  *
- * JPEG, PNG, WebP or TIFF format image data can be streamed out from this object.
+ * 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`.
+ *
+ * @constructs Sharp
+ *
+ * @emits Sharp#info
+ * @emits Sharp#warning
+ *
  * @example
  * sharp('input.jpg')
  *   .resize(300, 200)
@@ -47,46 +40,158 @@ const debuglog = util.debuglog('sharp');
  *   });
  *
  * @example
- * // Read image data from readableStream,
+ * // 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
- * var transformer = sharp()
+ * const { body } = fetch('https://...');
+ * const readableStream = Readable.fromWeb(body);
+ * const transformer = sharp()
  *   .resize(300)
- *   .on('info', function(info) {
- *     console.log('Image height is ' + info.height);
+ *   .on('info', ({ height }) => {
+ *     console.log(`Image height is ${height}`);
  *   });
  * readableStream.pipe(transformer).pipe(writableStream);
  *
  * @example
- * // Create a blank 300x200 PNG image of semi-transluent red pixels
+ * // 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: 128 }
+ *     background: { r: 255, g: 0, b: 0, alpha: 0.5 }
  *   }
  * })
  * .png()
  * .toBuffer()
  * .then( ... );
  *
- * @param {(Buffer|String)} [input] - if present, can be
- *  a Buffer containing JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data, or
- *  a String containing the path to an JPEG, PNG, WebP, GIF, SVG or TIFF image file.
- *  JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when not present.
+ * @example
+ * // Convert an animated GIF to an animated WebP
+ * await sharp('in.gif', { animated: true }).toFile('out.webp');
+ *
+ * @example
+ * // 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
+ * // Generate RGB Gaussian noise
+ * await sharp({
+ *   create: {
+ *     width: 300,
+ *     height: 200,
+ *     channels: 3,
+ *     noise: {
+ *       type: 'gaussian',
+ *       mean: 128,
+ *       sigma: 30
+ *     }
+ *  }
+ * }).toFile('noise.png');
+ *
+ * @example
+ * // Generate an image from text
+ * await sharp({
+ *   text: {
+ *     text: 'Hello, world!',
+ *     width: 400, // max width
+ *     height: 300 // max height
+ *   }
+ * }).toFile('text_bw.png');
+ *
+ * @example
+ * // 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
+ * // 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
+ * // 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');
+ *
+ * @param {(Buffer|ArrayBuffer|Uint8Array|Uint8ClampedArray|Int8Array|Uint16Array|Int16Array|Uint32Array|Int32Array|Float32Array|Float64Array|string|Array)} [input] - 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.
  * @param {Object} [options] - if present, is an Object with optional attributes.
- * @param {Number} [options.density=72] - integral number representing the DPI for vector images.
+ * @param {string} [options.failOn='warning'] - 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.
+ * @param {number|boolean} [options.limitInputPixels=268402689] - 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).
+ * @param {boolean} [options.unlimited=false] - Set this to `true` to remove safety features that help prevent memory exhaustion (JPEG, PNG, SVG, HEIF).
+ * @param {boolean} [options.autoOrient=false] - Set this to `true` to rotate/flip the image to match EXIF `Orientation`, if any.
+ * @param {boolean} [options.sequentialRead=true] - Set this to `false` to use random access rather than sequential read. Some operations will do this automatically.
+ * @param {number} [options.density=72] - number representing the DPI for vector images in the range 1 to 100000.
+ * @param {number} [options.ignoreIcc=false] - should the embedded ICC profile, if any, be ignored.
+ * @param {number} [options.pages=1] - Number of pages to extract for multi-page input (GIF, WebP, TIFF), use -1 for all pages.
+ * @param {number} [options.page=0] - Page number to start extracting from for multi-page input (GIF, WebP, TIFF), zero based.
+ * @param {number} [options.subifd=-1] - subIFD (Sub Image File Directory) to extract for OME-TIFF, defaults to main image.
+ * @param {number} [options.level=0] - level to extract from a multi-level input (OpenSlide), zero based.
+ * @param {string|Object} [options.pdfBackground] - 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. Requires the use of a globally-installed libvips compiled with support for PDFium, Poppler, ImageMagick or GraphicsMagick.
+ * @param {boolean} [options.animated=false] - Set to `true` to read all frames/pages of an animated image (GIF, WebP, TIFF), equivalent of setting `pages` to `-1`.
  * @param {Object} [options.raw] - describes raw pixel input image data. See `raw()` for pixel ordering.
- * @param {Number} [options.raw.width]
- * @param {Number} [options.raw.height]
- * @param {Number} [options.raw.channels] - 1-4
+ * @param {number} [options.raw.width] - integral number of pixels wide.
+ * @param {number} [options.raw.height] - integral number of pixels high.
+ * @param {number} [options.raw.channels] - integral number of channels, between 1 and 4.
+ * @param {boolean} [options.raw.premultiplied] - specifies that the raw input has already been premultiplied, set to `true`
+ *  to avoid sharp premultiplying the image. (optional, default `false`)
  * @param {Object} [options.create] - describes a new image to be created.
- * @param {Number} [options.create.width]
- * @param {Number} [options.create.height]
- * @param {Number} [options.create.channels] - 3-4
- * @param {String|Object} [options.create.background] - parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
+ * @param {number} [options.create.width] - integral number of pixels wide.
+ * @param {number} [options.create.height] - integral number of pixels high.
+ * @param {number} [options.create.channels] - integral number of channels, either 3 (RGB) or 4 (RGBA).
+ * @param {string|Object} [options.create.background] - parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
+ * @param {Object} [options.create.noise] - describes a noise to be created.
+ * @param {string} [options.create.noise.type] - type of generated noise, currently only `gaussian` is supported.
+ * @param {number} [options.create.noise.mean] - mean of pixels in generated noise.
+ * @param {number} [options.create.noise.sigma] - standard deviation of pixels in generated noise.
+ * @param {Object} [options.text] - describes a new text image to be created.
+ * @param {string} [options.text.text] - text to render as a UTF-8 string. It can contain Pango markup, for example `<i>Le</i>Monde`.
+ * @param {string} [options.text.font] - font name to render with.
+ * @param {string} [options.text.fontfile] - absolute filesystem path to a font file that can be used by `font`.
+ * @param {number} [options.text.width=0] - Integral number of pixels to word-wrap at. Lines of text wider than this will be broken at word boundaries.
+ * @param {number} [options.text.height=0] - 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.
+ * @param {string} [options.text.align='left'] - Alignment style for multi-line text (`'left'`, `'centre'`, `'center'`, `'right'`).
+ * @param {boolean} [options.text.justify=false] - set this to true to apply justification to the text.
+ * @param {number} [options.text.dpi=72] - the resolution (size) at which to render the text. Does not take effect if `height` is specified.
+ * @param {boolean} [options.text.rgba=false] - 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>`.
+ * @param {number} [options.text.spacing=0] - text line height in points. Will use the font line height if none is specified.
+ * @param {string} [options.text.wrap='word'] - word wrapping style when width is provided, one of: 'word', 'char', 'word-char' (prefer word, fallback to char) or 'none'.
+ * @param {Object} [options.join] - describes how an array of input images should be joined.
+ * @param {number} [options.join.across=1] - number of images to join horizontally.
+ * @param {boolean} [options.join.animated=false] - set this to `true` to join the images as an animated image.
+ * @param {number} [options.join.shim=0] - number of pixels to insert between joined images.
+ * @param {string|Object} [options.join.background] - parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
+ * @param {string} [options.join.halign='left'] - horizontal alignment style for images joined horizontally (`'left'`, `'centre'`, `'center'`, `'right'`).
+ * @param {string} [options.join.valign='top'] - vertical alignment style for images joined vertically (`'top'`, `'centre'`, `'center'`, `'bottom'`).
+ *
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
@@ -99,11 +204,6 @@ const Sharp = function (input, options) {
   }
   stream.Duplex.call(this);
   this.options = {
-    // input options
-    sequentialRead: false,
-    limitInputPixels: Math.pow(0x3FFF, 2),
-    // ICC profiles
-    iccProfilePath: path.join(__dirname, 'icc') + path.sep,
     // resize options
     topOffsetPre: -1,
     leftOffsetPre: -1,
@@ -116,9 +216,11 @@ const Sharp = function (input, options) {
     width: -1,
     height: -1,
     canvas: 'crop',
-    crop: 0,
-    useExifOrientation: false,
+    position: 0,
+    resizeBackground: [0, 0, 0, 255],
     angle: 0,
+    rotationAngle: 0,
+    rotationBackground: [0, 0, 0, 255],
     rotateBeforePreExtract: false,
     flip: false,
     flop: false,
@@ -126,42 +228,78 @@ const Sharp = function (input, options) {
     extendBottom: 0,
     extendLeft: 0,
     extendRight: 0,
+    extendBackground: [0, 0, 0, 255],
+    extendWith: 'background',
     withoutEnlargement: false,
+    withoutReduction: false,
+    affineMatrix: [],
+    affineBackground: [0, 0, 0, 255],
+    affineIdx: 0,
+    affineIdy: 0,
+    affineOdx: 0,
+    affineOdy: 0,
+    affineInterpolator: this.constructor.interpolators.bilinear,
     kernel: 'lanczos3',
-    interpolator: 'bicubic',
-    centreSampling: false,
+    fastShrinkOnLoad: true,
     // operations
-    background: [0, 0, 0, 255],
+    tint: [-1, 0, 0, 0],
     flatten: false,
+    flattenBackground: [0, 0, 0],
+    unflatten: false,
     negate: false,
+    negateAlpha: true,
+    medianSize: 0,
     blurSigma: 0,
+    precision: 'integer',
+    minAmpl: 0.2,
     sharpenSigma: 0,
-    sharpenFlat: 1,
-    sharpenJagged: 2,
+    sharpenM1: 1,
+    sharpenM2: 2,
+    sharpenX1: 2,
+    sharpenY2: 10,
+    sharpenY3: 20,
     threshold: 0,
     thresholdGrayscale: true,
-    trimTolerance: 0,
+    trimBackground: [],
+    trimThreshold: -1,
+    trimLineArt: false,
+    dilateWidth: 0,
+    erodeWidth: 0,
     gamma: 0,
+    gammaOut: 0,
     greyscale: false,
-    normalise: 0,
+    normalise: false,
+    normaliseLower: 1,
+    normaliseUpper: 99,
+    claheWidth: 0,
+    claheHeight: 0,
+    claheMaxSlope: 3,
+    brightness: 1,
+    saturation: 1,
+    hue: 0,
+    lightness: 0,
     booleanBufferIn: null,
     booleanFileIn: '',
     joinChannelIn: [],
     extractChannel: -1,
+    removeAlpha: false,
+    ensureAlpha: -1,
     colourspace: 'srgb',
-    // overlay
-    overlayGravity: 0,
-    overlayXOffset: -1,
-    overlayYOffset: -1,
-    overlayTile: false,
-    overlayCutout: false,
+    colourspacePipeline: 'last',
+    composite: [],
     // output
     fileOut: '',
     formatOut: 'input',
     streamOut: false,
-    withMetadata: false,
+    keepMetadata: 0,
     withMetadataOrientation: -1,
+    withMetadataDensity: 0,
+    withIccProfile: '',
+    withExif: {},
+    withExifMerge: true,
     resolveWithObject: false,
+    loop: -1,
+    delay: [],
     // output format
     jpegQuality: 80,
     jpegProgressive: false,
@@ -169,62 +307,177 @@ const Sharp = function (input, options) {
     jpegTrellisQuantisation: false,
     jpegOvershootDeringing: false,
     jpegOptimiseScans: false,
+    jpegOptimiseCoding: true,
+    jpegQuantisationTable: 0,
     pngProgressive: false,
     pngCompressionLevel: 6,
-    pngAdaptiveFiltering: true,
+    pngAdaptiveFiltering: false,
+    pngPalette: false,
+    pngQuality: 100,
+    pngEffort: 7,
+    pngBitdepth: 8,
+    pngDither: 1,
+    jp2Quality: 80,
+    jp2TileHeight: 512,
+    jp2TileWidth: 512,
+    jp2Lossless: false,
+    jp2ChromaSubsampling: '4:4:4',
     webpQuality: 80,
     webpAlphaQuality: 100,
     webpLossless: false,
     webpNearLossless: false,
+    webpSmartSubsample: false,
+    webpSmartDeblock: false,
+    webpPreset: 'default',
+    webpEffort: 4,
+    webpMinSize: false,
+    webpMixed: false,
+    gifBitdepth: 8,
+    gifEffort: 7,
+    gifDither: 1,
+    gifInterFrameMaxError: 0,
+    gifInterPaletteMaxError: 3,
+    gifReuse: true,
+    gifProgressive: false,
     tiffQuality: 80,
     tiffCompression: 'jpeg',
-    tiffPredictor: 'none',
-    tiffSquash: false,
+    tiffPredictor: 'horizontal',
+    tiffPyramid: false,
+    tiffMiniswhite: false,
+    tiffBitdepth: 8,
+    tiffTile: false,
+    tiffTileHeight: 256,
+    tiffTileWidth: 256,
+    tiffXres: 1.0,
+    tiffYres: 1.0,
+    tiffResolutionUnit: 'inch',
+    heifQuality: 50,
+    heifLossless: false,
+    heifCompression: 'av1',
+    heifEffort: 4,
+    heifChromaSubsampling: '4:4:4',
+    heifBitdepth: 8,
+    jxlDistance: 1,
+    jxlDecodingTier: 0,
+    jxlEffort: 7,
+    jxlLossless: false,
+    rawDepth: 'uchar',
     tileSize: 256,
     tileOverlap: 0,
+    tileContainer: 'fs',
+    tileLayout: 'dz',
+    tileFormat: 'last',
+    tileDepth: 'last',
+    tileAngle: 0,
+    tileSkipBlanks: -1,
+    tileBackground: [255, 255, 255, 255],
+    tileCentre: false,
+    tileId: 'https://example.com/iiif',
+    tileBasename: '',
+    timeoutSeconds: 0,
+    linearA: [],
+    linearB: [],
+    pdfBackground: [255, 255, 255, 255],
     // Function to notify of libvips warnings
-    debuglog: debuglog,
+    debuglog: warning => {
+      this.emit('warning', warning);
+      debuglog(warning);
+    },
     // Function to notify of queue length changes
     queueListener: function (queueLength) {
-      queue.emit('change', queueLength);
+      Sharp.queue.emit('change', queueLength);
     }
   };
   this.options.input = this._createInputDescriptor(input, options, { allowStream: true });
   return this;
 };
-util.inherits(Sharp, stream.Duplex);
+Object.setPrototypeOf(Sharp.prototype, stream.Duplex.prototype);
+Object.setPrototypeOf(Sharp, stream.Duplex);
 
 /**
- * An EventEmitter that emits a `change` event when a task is either:
- * - queued, waiting for _libuv_ to provide a worker thread
- * - complete
- * @member
+ * 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
- * sharp.queue.on('change', function(queueLength) {
- *   console.log('Queue contains ' + queueLength + ' task(s)');
- * });
- */
-const queue = new events.EventEmitter();
-Sharp.queue = queue;
-
-/**
- * An Object containing nested boolean values representing the available input and output formats/methods.
+ * 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
- * console.log(sharp.format);
- * @returns {Object}
+ * // 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) {}
+ *   });
+ *
+ * @returns {Sharp}
  */
-Sharp.format = sharp.format();
-
-/**
- * An Object containing the version numbers of libvips and its dependencies.
- * @member
- * @example
- * console.log(sharp.versions);
- */
-Sharp.versions = versions;
+function clone () {
+  // Clone existing options
+  const clone = this.constructor.call();
+  const { debuglog, queueListener, ...options } = this.options;
+  clone.options = structuredClone(options);
+  clone.options.debuglog = debuglog;
+  clone.options.queueListener = queueListener;
+  // Pass 'finish' event to clone for Stream-based input
+  if (this._isStreamInput()) {
+    this.on('finish', () => {
+      // Clone inherits input data
+      this._flattenBufferIn();
+      clone.options.input.buffer = this.options.input.buffer;
+      clone.emit('finish');
+    });
+  }
+  return clone;
+}
+Object.assign(Sharp.prototype, { clone });
 
 /**
  * Export constructor.
+ * @module Sharp
  * @private
  */
 module.exports = Sharp;

lib/index.js

@@ -1,17 +1,16 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
 'use strict';
 
 const Sharp = require('./constructor');
-[
-  'input',
-  'resize',
-  'composite',
-  'operation',
-  'colour',
-  'channel',
-  'output',
-  'utility'
-].forEach(function (decorator) {
-  require('./' + decorator)(Sharp);
-});
+require('./input')(Sharp);
+require('./resize')(Sharp);
+require('./composite')(Sharp);
+require('./operation')(Sharp);
+require('./colour')(Sharp);
+require('./channel')(Sharp);
+require('./output')(Sharp);
+require('./utility')(Sharp);
 
 module.exports = Sharp;

lib/input.js

@@ -1,37 +1,164 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
 'use strict';
 
-const color = require('color');
 const is = require('./is');
-const sharp = require('../build/Release/sharp.node');
+const sharp = require('./sharp');
+
+/**
+ * Justification alignment
+ * @member
+ * @private
+ */
+const align = {
+  left: 'low',
+  top: 'low',
+  low: 'low',
+  center: 'centre',
+  centre: 'centre',
+  right: 'high',
+  bottom: 'high',
+  high: 'high'
+};
+
+/**
+ * Extract input options, if any, from an object.
+ * @private
+ */
+function _inputOptionsFromObject (obj) {
+  const { raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd, pdfBackground, autoOrient } = obj;
+  return [raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd, pdfBackground, autoOrient].some(is.defined)
+    ? { raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd, pdfBackground, autoOrient }
+    : undefined;
+}
 
 /**
  * Create Object containing input and input-related options.
  * @private
  */
 function _createInputDescriptor (input, inputOptions, containerOptions) {
-  const inputDescriptor = {};
+  const inputDescriptor = {
+    autoOrient: false,
+    failOn: 'warning',
+    limitInputPixels: Math.pow(0x3FFF, 2),
+    ignoreIcc: false,
+    unlimited: false,
+    sequentialRead: true
+  };
   if (is.string(input)) {
     // filesystem
     inputDescriptor.file = input;
   } else if (is.buffer(input)) {
     // Buffer
+    if (input.length === 0) {
+      throw Error('Input Buffer is empty');
+    }
     inputDescriptor.buffer = input;
+  } else if (is.arrayBuffer(input)) {
+    if (input.byteLength === 0) {
+      throw Error('Input bit Array is empty');
+    }
+    inputDescriptor.buffer = Buffer.from(input, 0, input.byteLength);
+  } else if (is.typedArray(input)) {
+    if (input.length === 0) {
+      throw Error('Input Bit Array is empty');
+    }
+    inputDescriptor.buffer = Buffer.from(input.buffer, input.byteOffset, input.byteLength);
   } else if (is.plainObject(input) && !is.defined(inputOptions)) {
     // Plain Object descriptor, e.g. create
     inputOptions = input;
-  } else if (!is.defined(input) && is.object(containerOptions) && containerOptions.allowStream) {
-    // Stream
+    if (_inputOptionsFromObject(inputOptions)) {
+      // Stream with options
+      inputDescriptor.buffer = [];
+    }
+  } else if (!is.defined(input) && !is.defined(inputOptions) && is.object(containerOptions) && containerOptions.allowStream) {
+    // Stream without options
     inputDescriptor.buffer = [];
+  } else if (Array.isArray(input)) {
+    if (input.length > 1) {
+      // Join images together
+      if (!this.options.joining) {
+        this.options.joining = true;
+        this.options.join = input.map(i => this._createInputDescriptor(i));
+      } else {
+        throw new Error('Recursive join is unsupported');
+      }
+    } else {
+      throw new Error('Expected at least two images to join');
+    }
   } else {
-    throw new Error('Unsupported input ' + typeof input);
+    throw new Error(`Unsupported input '${input}' of type ${typeof input}${
+      is.defined(inputOptions) ? ` when also providing options of type ${typeof inputOptions}` : ''
+    }`);
   }
   if (is.object(inputOptions)) {
+    // Deprecated: failOnError
+    if (is.defined(inputOptions.failOnError)) {
+      if (is.bool(inputOptions.failOnError)) {
+        inputDescriptor.failOn = inputOptions.failOnError ? 'warning' : 'none';
+      } else {
+        throw is.invalidParameterError('failOnError', 'boolean', inputOptions.failOnError);
+      }
+    }
+    // failOn
+    if (is.defined(inputOptions.failOn)) {
+      if (is.string(inputOptions.failOn) && is.inArray(inputOptions.failOn, ['none', 'truncated', 'error', 'warning'])) {
+        inputDescriptor.failOn = inputOptions.failOn;
+      } else {
+        throw is.invalidParameterError('failOn', 'one of: none, truncated, error, warning', inputOptions.failOn);
+      }
+    }
+    // autoOrient
+    if (is.defined(inputOptions.autoOrient)) {
+      if (is.bool(inputOptions.autoOrient)) {
+        inputDescriptor.autoOrient = inputOptions.autoOrient;
+      } else {
+        throw is.invalidParameterError('autoOrient', 'boolean', inputOptions.autoOrient);
+      }
+    }
     // Density
     if (is.defined(inputOptions.density)) {
-      if (is.integer(inputOptions.density) && is.inRange(inputOptions.density, 1, 2400)) {
+      if (is.inRange(inputOptions.density, 1, 100000)) {
         inputDescriptor.density = inputOptions.density;
       } else {
-        throw new Error('Invalid density (1 to 2400) ' + inputOptions.density);
+        throw is.invalidParameterError('density', 'number between 1 and 100000', inputOptions.density);
+      }
+    }
+    // Ignore embeddded ICC profile
+    if (is.defined(inputOptions.ignoreIcc)) {
+      if (is.bool(inputOptions.ignoreIcc)) {
+        inputDescriptor.ignoreIcc = inputOptions.ignoreIcc;
+      } else {
+        throw is.invalidParameterError('ignoreIcc', 'boolean', inputOptions.ignoreIcc);
+      }
+    }
+    // limitInputPixels
+    if (is.defined(inputOptions.limitInputPixels)) {
+      if (is.bool(inputOptions.limitInputPixels)) {
+        inputDescriptor.limitInputPixels = inputOptions.limitInputPixels
+          ? Math.pow(0x3FFF, 2)
+          : 0;
+      } else if (is.integer(inputOptions.limitInputPixels) && is.inRange(inputOptions.limitInputPixels, 0, Number.MAX_SAFE_INTEGER)) {
+        inputDescriptor.limitInputPixels = inputOptions.limitInputPixels;
+      } else {
+        throw is.invalidParameterError('limitInputPixels', 'positive integer', inputOptions.limitInputPixels);
+      }
+    }
+    // unlimited
+    if (is.defined(inputOptions.unlimited)) {
+      if (is.bool(inputOptions.unlimited)) {
+        inputDescriptor.unlimited = inputOptions.unlimited;
+      } else {
+        throw is.invalidParameterError('unlimited', 'boolean', inputOptions.unlimited);
+      }
+    }
+    // sequentialRead
+    if (is.defined(inputOptions.sequentialRead)) {
+      if (is.bool(inputOptions.sequentialRead)) {
+        inputDescriptor.sequentialRead = inputOptions.sequentialRead;
+      } else {
+        throw is.invalidParameterError('sequentialRead', 'boolean', inputOptions.sequentialRead);
       }
     }
     // Raw pixel input
@@ -45,32 +172,255 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
         inputDescriptor.rawWidth = inputOptions.raw.width;
         inputDescriptor.rawHeight = inputOptions.raw.height;
         inputDescriptor.rawChannels = inputOptions.raw.channels;
+        inputDescriptor.rawPremultiplied = !!inputOptions.raw.premultiplied;
+
+        switch (input.constructor) {
+          case Uint8Array:
+          case Uint8ClampedArray:
+            inputDescriptor.rawDepth = 'uchar';
+            break;
+          case Int8Array:
+            inputDescriptor.rawDepth = 'char';
+            break;
+          case Uint16Array:
+            inputDescriptor.rawDepth = 'ushort';
+            break;
+          case Int16Array:
+            inputDescriptor.rawDepth = 'short';
+            break;
+          case Uint32Array:
+            inputDescriptor.rawDepth = 'uint';
+            break;
+          case Int32Array:
+            inputDescriptor.rawDepth = 'int';
+            break;
+          case Float32Array:
+            inputDescriptor.rawDepth = 'float';
+            break;
+          case Float64Array:
+            inputDescriptor.rawDepth = 'double';
+            break;
+          default:
+            inputDescriptor.rawDepth = 'uchar';
+            break;
+        }
       } else {
         throw new Error('Expected width, height and channels for raw pixel input');
       }
     }
+    // Multi-page input (GIF, TIFF, PDF)
+    if (is.defined(inputOptions.animated)) {
+      if (is.bool(inputOptions.animated)) {
+        inputDescriptor.pages = inputOptions.animated ? -1 : 1;
+      } else {
+        throw is.invalidParameterError('animated', 'boolean', inputOptions.animated);
+      }
+    }
+    if (is.defined(inputOptions.pages)) {
+      if (is.integer(inputOptions.pages) && is.inRange(inputOptions.pages, -1, 100000)) {
+        inputDescriptor.pages = inputOptions.pages;
+      } else {
+        throw is.invalidParameterError('pages', 'integer between -1 and 100000', inputOptions.pages);
+      }
+    }
+    if (is.defined(inputOptions.page)) {
+      if (is.integer(inputOptions.page) && is.inRange(inputOptions.page, 0, 100000)) {
+        inputDescriptor.page = inputOptions.page;
+      } else {
+        throw is.invalidParameterError('page', 'integer between 0 and 100000', inputOptions.page);
+      }
+    }
+    // Multi-level input (OpenSlide)
+    if (is.defined(inputOptions.level)) {
+      if (is.integer(inputOptions.level) && is.inRange(inputOptions.level, 0, 256)) {
+        inputDescriptor.level = inputOptions.level;
+      } else {
+        throw is.invalidParameterError('level', 'integer between 0 and 256', inputOptions.level);
+      }
+    }
+    // Sub Image File Directory (TIFF)
+    if (is.defined(inputOptions.subifd)) {
+      if (is.integer(inputOptions.subifd) && is.inRange(inputOptions.subifd, -1, 100000)) {
+        inputDescriptor.subifd = inputOptions.subifd;
+      } else {
+        throw is.invalidParameterError('subifd', 'integer between -1 and 100000', inputOptions.subifd);
+      }
+    }
+    // PDF background colour
+    if (is.defined(inputOptions.pdfBackground)) {
+      inputDescriptor.pdfBackground = this._getBackgroundColourOption(inputOptions.pdfBackground);
+    }
     // Create new image
     if (is.defined(inputOptions.create)) {
       if (
         is.object(inputOptions.create) &&
         is.integer(inputOptions.create.width) && inputOptions.create.width > 0 &&
         is.integer(inputOptions.create.height) && inputOptions.create.height > 0 &&
-        is.integer(inputOptions.create.channels) && is.inRange(inputOptions.create.channels, 3, 4) &&
-        is.defined(inputOptions.create.background)
+        is.integer(inputOptions.create.channels)
       ) {
         inputDescriptor.createWidth = inputOptions.create.width;
         inputDescriptor.createHeight = inputOptions.create.height;
         inputDescriptor.createChannels = inputOptions.create.channels;
-        const background = color(inputOptions.create.background);
-        inputDescriptor.createBackground = [
-          background.red(),
-          background.green(),
-          background.blue(),
-          Math.round(background.alpha() * 255)
-        ];
+        // Noise
+        if (is.defined(inputOptions.create.noise)) {
+          if (!is.object(inputOptions.create.noise)) {
+            throw new Error('Expected noise to be an object');
+          }
+          if (!is.inArray(inputOptions.create.noise.type, ['gaussian'])) {
+            throw new Error('Only gaussian noise is supported at the moment');
+          }
+          if (!is.inRange(inputOptions.create.channels, 1, 4)) {
+            throw is.invalidParameterError('create.channels', 'number between 1 and 4', inputOptions.create.channels);
+          }
+          inputDescriptor.createNoiseType = inputOptions.create.noise.type;
+          if (is.number(inputOptions.create.noise.mean) && is.inRange(inputOptions.create.noise.mean, 0, 10000)) {
+            inputDescriptor.createNoiseMean = inputOptions.create.noise.mean;
+          } else {
+            throw is.invalidParameterError('create.noise.mean', 'number between 0 and 10000', inputOptions.create.noise.mean);
+          }
+          if (is.number(inputOptions.create.noise.sigma) && is.inRange(inputOptions.create.noise.sigma, 0, 10000)) {
+            inputDescriptor.createNoiseSigma = inputOptions.create.noise.sigma;
+          } else {
+            throw is.invalidParameterError('create.noise.sigma', 'number between 0 and 10000', inputOptions.create.noise.sigma);
+          }
+        } else if (is.defined(inputOptions.create.background)) {
+          if (!is.inRange(inputOptions.create.channels, 3, 4)) {
+            throw is.invalidParameterError('create.channels', 'number between 3 and 4', inputOptions.create.channels);
+          }
+          inputDescriptor.createBackground = this._getBackgroundColourOption(inputOptions.create.background);
+        } else {
+          throw new Error('Expected valid noise or background to create a new input image');
+        }
         delete inputDescriptor.buffer;
       } else {
-        throw new Error('Expected width, height, channels and background to create a new input image');
+        throw new Error('Expected valid width, height and channels to create a new input image');
+      }
+    }
+    // Create a new image with text
+    if (is.defined(inputOptions.text)) {
+      if (is.object(inputOptions.text) && is.string(inputOptions.text.text)) {
+        inputDescriptor.textValue = inputOptions.text.text;
+        if (is.defined(inputOptions.text.height) && is.defined(inputOptions.text.dpi)) {
+          throw new Error('Expected only one of dpi or height');
+        }
+        if (is.defined(inputOptions.text.font)) {
+          if (is.string(inputOptions.text.font)) {
+            inputDescriptor.textFont = inputOptions.text.font;
+          } else {
+            throw is.invalidParameterError('text.font', 'string', inputOptions.text.font);
+          }
+        }
+        if (is.defined(inputOptions.text.fontfile)) {
+          if (is.string(inputOptions.text.fontfile)) {
+            inputDescriptor.textFontfile = inputOptions.text.fontfile;
+          } else {
+            throw is.invalidParameterError('text.fontfile', 'string', inputOptions.text.fontfile);
+          }
+        }
+        if (is.defined(inputOptions.text.width)) {
+          if (is.integer(inputOptions.text.width) && inputOptions.text.width > 0) {
+            inputDescriptor.textWidth = inputOptions.text.width;
+          } else {
+            throw is.invalidParameterError('text.width', 'positive integer', inputOptions.text.width);
+          }
+        }
+        if (is.defined(inputOptions.text.height)) {
+          if (is.integer(inputOptions.text.height) && inputOptions.text.height > 0) {
+            inputDescriptor.textHeight = inputOptions.text.height;
+          } else {
+            throw is.invalidParameterError('text.height', 'positive integer', inputOptions.text.height);
+          }
+        }
+        if (is.defined(inputOptions.text.align)) {
+          if (is.string(inputOptions.text.align) && is.string(this.constructor.align[inputOptions.text.align])) {
+            inputDescriptor.textAlign = this.constructor.align[inputOptions.text.align];
+          } else {
+            throw is.invalidParameterError('text.align', 'valid alignment', inputOptions.text.align);
+          }
+        }
+        if (is.defined(inputOptions.text.justify)) {
+          if (is.bool(inputOptions.text.justify)) {
+            inputDescriptor.textJustify = inputOptions.text.justify;
+          } else {
+            throw is.invalidParameterError('text.justify', 'boolean', inputOptions.text.justify);
+          }
+        }
+        if (is.defined(inputOptions.text.dpi)) {
+          if (is.integer(inputOptions.text.dpi) && is.inRange(inputOptions.text.dpi, 1, 1000000)) {
+            inputDescriptor.textDpi = inputOptions.text.dpi;
+          } else {
+            throw is.invalidParameterError('text.dpi', 'integer between 1 and 1000000', inputOptions.text.dpi);
+          }
+        }
+        if (is.defined(inputOptions.text.rgba)) {
+          if (is.bool(inputOptions.text.rgba)) {
+            inputDescriptor.textRgba = inputOptions.text.rgba;
+          } else {
+            throw is.invalidParameterError('text.rgba', 'bool', inputOptions.text.rgba);
+          }
+        }
+        if (is.defined(inputOptions.text.spacing)) {
+          if (is.integer(inputOptions.text.spacing) && is.inRange(inputOptions.text.spacing, -1000000, 1000000)) {
+            inputDescriptor.textSpacing = inputOptions.text.spacing;
+          } else {
+            throw is.invalidParameterError('text.spacing', 'integer between -1000000 and 1000000', inputOptions.text.spacing);
+          }
+        }
+        if (is.defined(inputOptions.text.wrap)) {
+          if (is.string(inputOptions.text.wrap) && is.inArray(inputOptions.text.wrap, ['word', 'char', 'word-char', 'none'])) {
+            inputDescriptor.textWrap = inputOptions.text.wrap;
+          } else {
+            throw is.invalidParameterError('text.wrap', 'one of: word, char, word-char, none', inputOptions.text.wrap);
+          }
+        }
+        delete inputDescriptor.buffer;
+      } else {
+        throw new Error('Expected a valid string to create an image with text.');
+      }
+    }
+    // Join images together
+    if (is.defined(inputOptions.join)) {
+      if (is.defined(this.options.join)) {
+        if (is.defined(inputOptions.join.animated)) {
+          if (is.bool(inputOptions.join.animated)) {
+            inputDescriptor.joinAnimated = inputOptions.join.animated;
+          } else {
+            throw is.invalidParameterError('join.animated', 'boolean', inputOptions.join.animated);
+          }
+        }
+        if (is.defined(inputOptions.join.across)) {
+          if (is.integer(inputOptions.join.across) && is.inRange(inputOptions.join.across, 1, 1000000)) {
+            inputDescriptor.joinAcross = inputOptions.join.across;
+          } else {
+            throw is.invalidParameterError('join.across', 'integer between 1 and 100000', inputOptions.join.across);
+          }
+        }
+        if (is.defined(inputOptions.join.shim)) {
+          if (is.integer(inputOptions.join.shim) && is.inRange(inputOptions.join.shim, 0, 1000000)) {
+            inputDescriptor.joinShim = inputOptions.join.shim;
+          } else {
+            throw is.invalidParameterError('join.shim', 'integer between 0 and 100000', inputOptions.join.shim);
+          }
+        }
+        if (is.defined(inputOptions.join.background)) {
+          inputDescriptor.joinBackground = this._getBackgroundColourOption(inputOptions.join.background);
+        }
+        if (is.defined(inputOptions.join.halign)) {
+          if (is.string(inputOptions.join.halign) && is.string(this.constructor.align[inputOptions.join.halign])) {
+            inputDescriptor.joinHalign = this.constructor.align[inputOptions.join.halign];
+          } else {
+            throw is.invalidParameterError('join.halign', 'valid alignment', inputOptions.join.halign);
+          }
+        }
+        if (is.defined(inputOptions.join.valign)) {
+          if (is.string(inputOptions.join.valign) && is.string(this.constructor.align[inputOptions.join.valign])) {
+            inputDescriptor.joinValign = this.constructor.align[inputOptions.join.valign];
+          } else {
+            throw is.invalidParameterError('join.valign', 'valid alignment', inputOptions.join.valign);
+          }
+        }
+      } else {
+        throw new Error('Expected input to be an array of images to join');
       }
     }
   } else if (is.defined(inputOptions)) {
@@ -83,7 +433,7 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
  * Handle incoming Buffer chunk on Writable Stream.
  * @private
  * @param {Buffer} chunk
- * @param {String} encoding - unused
+ * @param {string} encoding - unused
  * @param {Function} callback
  */
 function _write (chunk, encoding, callback) {
@@ -92,9 +442,8 @@ function _write (chunk, encoding, callback) {
     /* istanbul ignore else */
     if (is.buffer(chunk)) {
       if (this.options.input.buffer.length === 0) {
-        const that = this;
-        this.on('finish', function () {
-          that.streamInFinished = true;
+        this.on('finish', () => {
+          this.streamInFinished = true;
         });
       }
       this.options.input.buffer.push(chunk);
@@ -120,58 +469,59 @@ function _flattenBufferIn () {
 /**
  * Are we expecting Stream-based input?
  * @private
- * @returns {Boolean}
+ * @returns {boolean}
  */
 function _isStreamInput () {
   return Array.isArray(this.options.input.buffer);
 }
 
 /**
- * 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.
+ * Fast access to (uncached) image metadata without decoding any compressed pixel data.
  *
- * @example
- * 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
+ * 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.
  *
- * @returns {Sharp}
- */
-function clone () {
-  const that = this;
-  // Clone existing options
-  const clone = this.constructor.call();
-  clone.options = Object.assign({}, this.options);
-  // Pass 'finish' event to clone for Stream-based input
-  this.on('finish', function () {
-    // Clone inherits input data
-    that._flattenBufferIn();
-    clone.options.bufferIn = that.options.bufferIn;
-    clone.emit('finish');
-  });
-  return clone;
-}
-
-/**
- * Fast access to (uncached) image metadata without decoding any compressed image data.
- * A Promises/A+ promise is returned when `callback` is not provided.
+ * Dimensions in the response will respect the `page` and `pages` properties of the
+ * {@link /api-constructor#parameters|constructor parameters}.
+ *
+ * A `Promise` is returned when `callback` is not provided.
  *
  * - `format`: Name of decoder used to decompress image data e.g. `jpeg`, `png`, `webp`, `gif`, `svg`
- * - `width`: Number of pixels wide
- * - `height`: Number of pixels high
- * - `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L636)
+ * - `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/VipsImage.html#VipsInterpretation)
  * - `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://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L672)
+ * - `depth`: Name of pixel depth format e.g. `uchar`, `char`, `ushort`, `float` [...](https://www.libvips.org/API/current/VipsImage.html#VipsBandFormat)
  * - `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
+ * - `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.
+ *
+ * @example
+ * const metadata = await sharp(input).metadata();
  *
  * @example
  * const image = sharp(inputJpg);
@@ -187,40 +537,62 @@ function clone () {
  *     // data contains a WebP image half the width and height of the original JPEG
  *   });
  *
+ * @example
+ * // Get dimensions taking EXIF Orientation into account.
+ * const { autoOrient } = await sharp(input).metadata();
+ * const { width, height } = autoOrient;
+ *
  * @param {Function} [callback] - called with the arguments `(err, metadata)`
  * @returns {Promise<Object>|Sharp}
  */
 function metadata (callback) {
-  const that = this;
+  const stack = Error();
   if (is.fn(callback)) {
     if (this._isStreamInput()) {
-      this.on('finish', function () {
-        that._flattenBufferIn();
-        sharp.metadata(that.options, callback);
+      this.on('finish', () => {
+        this._flattenBufferIn();
+        sharp.metadata(this.options, (err, metadata) => {
+          if (err) {
+            callback(is.nativeError(err, stack));
+          } else {
+            callback(null, metadata);
+          }
+        });
       });
     } else {
-      sharp.metadata(this.options, callback);
+      sharp.metadata(this.options, (err, metadata) => {
+        if (err) {
+          callback(is.nativeError(err, stack));
+        } else {
+          callback(null, metadata);
+        }
+      });
     }
     return this;
   } else {
     if (this._isStreamInput()) {
-      return new Promise(function (resolve, reject) {
-        that.on('finish', function () {
-          that._flattenBufferIn();
-          sharp.metadata(that.options, function (err, metadata) {
+      return new Promise((resolve, reject) => {
+        const finished = () => {
+          this._flattenBufferIn();
+          sharp.metadata(this.options, (err, metadata) => {
             if (err) {
-              reject(err);
+              reject(is.nativeError(err, stack));
             } else {
               resolve(metadata);
             }
           });
-        });
+        };
+        if (this.writableFinished) {
+          finished();
+        } else {
+          this.once('finish', finished);
+        }
       });
     } else {
-      return new Promise(function (resolve, reject) {
-        sharp.metadata(that.options, function (err, metadata) {
+      return new Promise((resolve, reject) => {
+        sharp.metadata(this.options, (err, metadata) => {
           if (err) {
-            reject(err);
+            reject(is.nativeError(err, stack));
           } else {
             resolve(metadata);
           }
@@ -231,56 +603,119 @@ function metadata (callback) {
 }
 
 /**
- * Do not process input images where the number of pixels (width * height) exceeds this limit.
- * Assumes image dimensions contained in the input metadata can be trusted.
- * The default limit is 268402689 (0x3FFF * 0x3FFF) pixels.
- * @param {(Number|Boolean)} limit - an integral Number of pixels, zero or false to remove limit, true to use default limit.
- * @returns {Sharp}
- * @throws {Error} Invalid limit
-*/
-function limitInputPixels (limit) {
-  // if we pass in false we represent the integer as 0 to disable
-  if (limit === false) {
-    limit = 0;
-  } else if (limit === true) {
-    limit = Math.pow(0x3FFF, 2);
-  }
-  if (is.integer(limit) && limit >= 0) {
-    this.options.limitInputPixels = limit;
-  } else {
-    throw is.invalidParameterError('limitInputPixels', 'integer', limit);
-  }
-  return this;
-}
-
-/**
- * An advanced setting that switches the libvips access method to `VIPS_ACCESS_SEQUENTIAL`.
- * This will reduce memory usage and can improve performance on some systems.
- * @param {Boolean} [sequentialRead=true]
- * @returns {Sharp}
+ * 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).
+ *
+ * @example
+ * const image = sharp(inputJpg);
+ * image
+ *   .stats()
+ *   .then(function(stats) {
+ *      // stats contains the channel-wise statistics array and the isOpaque value
+ *   });
+ *
+ * @example
+ * const { entropy, sharpness, dominant } = await sharp(input).stats();
+ * const { r, g, b } = dominant;
+ *
+ * @example
+ * 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();
+ *
+ * @param {Function} [callback] - called with the arguments `(err, stats)`
+ * @returns {Promise<Object>}
  */
-function sequentialRead (sequentialRead) {
-  this.options.sequentialRead = is.bool(sequentialRead) ? sequentialRead : true;
-  return this;
+function stats (callback) {
+  const stack = Error();
+  if (is.fn(callback)) {
+    if (this._isStreamInput()) {
+      this.on('finish', () => {
+        this._flattenBufferIn();
+        sharp.stats(this.options, (err, stats) => {
+          if (err) {
+            callback(is.nativeError(err, stack));
+          } else {
+            callback(null, stats);
+          }
+        });
+      });
+    } else {
+      sharp.stats(this.options, (err, stats) => {
+        if (err) {
+          callback(is.nativeError(err, stack));
+        } else {
+          callback(null, stats);
+        }
+      });
+    }
+    return this;
+  } else {
+    if (this._isStreamInput()) {
+      return new Promise((resolve, reject) => {
+        this.on('finish', function () {
+          this._flattenBufferIn();
+          sharp.stats(this.options, (err, stats) => {
+            if (err) {
+              reject(is.nativeError(err, stack));
+            } else {
+              resolve(stats);
+            }
+          });
+        });
+      });
+    } else {
+      return new Promise((resolve, reject) => {
+        sharp.stats(this.options, (err, stats) => {
+          if (err) {
+            reject(is.nativeError(err, stack));
+          } else {
+            resolve(stats);
+          }
+        });
+      });
+    }
+  }
 }
 
 /**
  * Decorate the Sharp prototype with input-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {
-  [
+  Object.assign(Sharp.prototype, {
     // Private
+    _inputOptionsFromObject,
     _createInputDescriptor,
     _write,
     _flattenBufferIn,
     _isStreamInput,
     // Public
-    clone,
     metadata,
-    limitInputPixels,
-    sequentialRead
-  ].forEach(function (f) {
-    Sharp.prototype[f.name] = f;
+    stats
   });
+  // Class attributes
+  Sharp.align = align;
 };

lib/is.js

@@ -1,3 +1,6 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
 'use strict';
 
 /**
@@ -21,7 +24,7 @@ const object = function (val) {
  * @private
  */
 const plainObject = function (val) {
-  return object(val) && Object.prototype.toString.call(val) === '[object Object]';
+  return Object.prototype.toString.call(val) === '[object Object]';
 };
 
 /**
@@ -45,7 +48,38 @@ const bool = function (val) {
  * @private
  */
 const buffer = function (val) {
-  return object(val) && val instanceof Buffer;
+  return val instanceof Buffer;
+};
+
+/**
+ * Is this value a typed array object?. E.g. Uint8Array or Uint8ClampedArray?
+ * @private
+ */
+const typedArray = function (val) {
+  if (defined(val)) {
+    switch (val.constructor) {
+      case Uint8Array:
+      case Uint8ClampedArray:
+      case Int8Array:
+      case Uint16Array:
+      case Int16Array:
+      case Uint32Array:
+      case Int32Array:
+      case Float32Array:
+      case Float64Array:
+        return true;
+    }
+  }
+
+  return false;
+};
+
+/**
+ * Is this value an ArrayBuffer object?
+ * @private
+ */
+const arrayBuffer = function (val) {
+  return val instanceof ArrayBuffer;
 };
 
 /**
@@ -69,7 +103,7 @@ const number = function (val) {
  * @private
  */
 const integer = function (val) {
-  return number(val) && val % 1 === 0;
+  return Number.isInteger(val);
 };
 
 /**
@@ -85,14 +119,14 @@ const inRange = function (val, min, max) {
  * @private
  */
 const inArray = function (val, list) {
-  return list.indexOf(val) !== -1;
+  return list.includes(val);
 };
 
 /**
  * Create an Error with a message relating to an invalid parameter.
  *
- * @param {String} name - parameter name.
- * @param {String} expected - description of the type/value/range expected.
+ * @param {string} name - parameter name.
+ * @param {string} expected - description of the type/value/range expected.
  * @param {*} actual - the value received.
  * @returns {Error} Containing the formatted message.
  * @private
@@ -103,17 +137,33 @@ const invalidParameterError = function (name, expected, actual) {
   );
 };
 
-module.exports = {
-  defined: defined,
-  object: object,
-  plainObject: plainObject,
-  fn: fn,
-  bool: bool,
-  buffer: buffer,
-  string: string,
-  number: number,
-  integer: integer,
-  inRange: inRange,
-  inArray: inArray,
-  invalidParameterError: invalidParameterError
+/**
+ * Ensures an Error from C++ contains a JS stack.
+ *
+ * @param {Error} native - Error with message from C++.
+ * @param {Error} context - Error with stack from JS.
+ * @returns {Error} Error with message and stack.
+ * @private
+ */
+const nativeError = function (native, context) {
+  context.message = native.message;
+  return context;
+};
+
+module.exports = {
+  defined,
+  object,
+  plainObject,
+  fn,
+  bool,
+  buffer,
+  typedArray,
+  arrayBuffer,
+  string,
+  number,
+  integer,
+  inRange,
+  inArray,
+  invalidParameterError,
+  nativeError
 };

lib/libvips.js

@@ -0,0 +1,205 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
+'use strict';
+
+const { spawnSync } = require('node:child_process');
+const { createHash } = require('node:crypto');
+const semverCoerce = require('semver/functions/coerce');
+const semverGreaterThanOrEqualTo = require('semver/functions/gte');
+const semverSatisfies = require('semver/functions/satisfies');
+const detectLibc = require('detect-libc');
+
+const { config, engines, optionalDependencies } = require('../package.json');
+
+const minimumLibvipsVersionLabelled = process.env.npm_package_config_libvips || /* istanbul ignore next */
+  config.libvips;
+const minimumLibvipsVersion = semverCoerce(minimumLibvipsVersionLabelled).version;
+
+const prebuiltPlatforms = [
+  'darwin-arm64', 'darwin-x64',
+  'linux-arm', 'linux-arm64', 'linux-ppc64', 'linux-s390x', 'linux-x64',
+  'linuxmusl-arm64', 'linuxmusl-x64',
+  'win32-arm64', 'win32-ia32', 'win32-x64'
+];
+
+const spawnSyncOptions = {
+  encoding: 'utf8',
+  shell: true
+};
+
+const log = (item) => {
+  if (item instanceof Error) {
+    console.error(`sharp: Installation error: ${item.message}`);
+  } else {
+    console.log(`sharp: ${item}`);
+  }
+};
+
+/* istanbul ignore next */
+const runtimeLibc = () => detectLibc.isNonGlibcLinuxSync() ? detectLibc.familySync() : '';
+
+const runtimePlatformArch = () => `${process.platform}${runtimeLibc()}-${process.arch}`;
+
+/* istanbul ignore next */
+const buildPlatformArch = () => {
+  if (isEmscripten()) {
+    return 'wasm32';
+  }
+  /* eslint camelcase: ["error", { allow: ["^npm_config_"] }] */
+  const { npm_config_arch, npm_config_platform, npm_config_libc } = process.env;
+  const libc = typeof npm_config_libc === 'string' ? npm_config_libc : runtimeLibc();
+  return `${npm_config_platform || process.platform}${libc}-${npm_config_arch || process.arch}`;
+};
+
+const buildSharpLibvipsIncludeDir = () => {
+  try {
+    return require(`@img/sharp-libvips-dev-${buildPlatformArch()}/include`);
+  } catch {
+    try {
+      return require('@img/sharp-libvips-dev/include');
+    } catch {}
+  }
+  /* istanbul ignore next */
+  return '';
+};
+
+const buildSharpLibvipsCPlusPlusDir = () => {
+  try {
+    return require('@img/sharp-libvips-dev/cplusplus');
+  } catch {}
+  /* istanbul ignore next */
+  return '';
+};
+
+const buildSharpLibvipsLibDir = () => {
+  try {
+    return require(`@img/sharp-libvips-dev-${buildPlatformArch()}/lib`);
+  } catch {
+    try {
+      return require(`@img/sharp-libvips-${buildPlatformArch()}/lib`);
+    } catch {}
+  }
+  /* istanbul ignore next */
+  return '';
+};
+
+const isUnsupportedNodeRuntime = () => {
+  /* istanbul ignore next */
+  if (process.release?.name === 'node' && process.versions) {
+    if (!semverSatisfies(process.versions.node, engines.node)) {
+      return { found: process.versions.node, expected: engines.node };
+    }
+  }
+};
+
+/* istanbul ignore next */
+const isEmscripten = () => {
+  const { CC } = process.env;
+  return Boolean(CC && CC.endsWith('/emcc'));
+};
+
+const isRosetta = () => {
+  /* istanbul ignore next */
+  if (process.platform === 'darwin' && process.arch === 'x64') {
+    const translated = spawnSync('sysctl sysctl.proc_translated', spawnSyncOptions).stdout;
+    return (translated || '').trim() === 'sysctl.proc_translated: 1';
+  }
+  return false;
+};
+
+const sha512 = (s) => createHash('sha512').update(s).digest('hex');
+
+const yarnLocator = () => {
+  try {
+    const identHash = sha512(`imgsharp-libvips-${buildPlatformArch()}`);
+    const npmVersion = semverCoerce(optionalDependencies[`@img/sharp-libvips-${buildPlatformArch()}`], {
+      includePrerelease: true
+    }).version;
+    return sha512(`${identHash}npm:${npmVersion}`).slice(0, 10);
+  } catch {}
+  return '';
+};
+
+/* istanbul ignore next */
+const spawnRebuild = () =>
+  spawnSync(`node-gyp rebuild --directory=src ${isEmscripten() ? '--nodedir=emscripten' : ''}`, {
+    ...spawnSyncOptions,
+    stdio: 'inherit'
+  }).status;
+
+const globalLibvipsVersion = () => {
+  if (process.platform !== 'win32') {
+    const globalLibvipsVersion = spawnSync('pkg-config --modversion vips-cpp', {
+      ...spawnSyncOptions,
+      env: {
+        ...process.env,
+        PKG_CONFIG_PATH: pkgConfigPath()
+      }
+    }).stdout;
+    /* istanbul ignore next */
+    return (globalLibvipsVersion || '').trim();
+  } else {
+    return '';
+  }
+};
+
+/* istanbul ignore next */
+const pkgConfigPath = () => {
+  if (process.platform !== 'win32') {
+    const brewPkgConfigPath = spawnSync(
+      'which brew >/dev/null 2>&1 && brew environment --plain | grep PKG_CONFIG_LIBDIR | cut -d" " -f2',
+      spawnSyncOptions
+    ).stdout || '';
+    return [
+      brewPkgConfigPath.trim(),
+      process.env.PKG_CONFIG_PATH,
+      '/usr/local/lib/pkgconfig',
+      '/usr/lib/pkgconfig',
+      '/usr/local/libdata/pkgconfig',
+      '/usr/libdata/pkgconfig'
+    ].filter(Boolean).join(':');
+  } else {
+    return '';
+  }
+};
+
+const skipSearch = (status, reason, logger) => {
+  if (logger) {
+    logger(`Detected ${reason}, skipping search for globally-installed libvips`);
+  }
+  return status;
+};
+
+const useGlobalLibvips = (logger) => {
+  if (Boolean(process.env.SHARP_IGNORE_GLOBAL_LIBVIPS) === true) {
+    return skipSearch(false, 'SHARP_IGNORE_GLOBAL_LIBVIPS', logger);
+  }
+  if (Boolean(process.env.SHARP_FORCE_GLOBAL_LIBVIPS) === true) {
+    return skipSearch(true, 'SHARP_FORCE_GLOBAL_LIBVIPS', logger);
+  }
+  /* istanbul ignore next */
+  if (isRosetta()) {
+    return skipSearch(false, 'Rosetta', logger);
+  }
+  const globalVipsVersion = globalLibvipsVersion();
+  return !!globalVipsVersion && /* istanbul ignore next */
+    semverGreaterThanOrEqualTo(globalVipsVersion, minimumLibvipsVersion);
+};
+
+module.exports = {
+  minimumLibvipsVersion,
+  prebuiltPlatforms,
+  buildPlatformArch,
+  buildSharpLibvipsIncludeDir,
+  buildSharpLibvipsCPlusPlusDir,
+  buildSharpLibvipsLibDir,
+  isUnsupportedNodeRuntime,
+  runtimePlatformArch,
+  log,
+  yarnLocator,
+  spawnRebuild,
+  globalLibvipsVersion,
+  pkgConfigPath,
+  useGlobalLibvips
+};

lib/resize.js

@@ -1,9 +1,12 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
 'use strict';
 
 const is = require('./is');
 
 /**
- * Weighting to apply to image crop.
+ * Weighting to apply when using contain/cover fit.
  * @member
  * @private
  */
@@ -21,7 +24,35 @@ const gravity = {
 };
 
 /**
- * Strategies for automagic crop behaviour.
+ * Position to apply when using contain/cover fit.
+ * @member
+ * @private
+ */
+const position = {
+  top: 1,
+  right: 2,
+  bottom: 3,
+  left: 4,
+  'right top': 5,
+  'right bottom': 6,
+  'left bottom': 7,
+  'left top': 8
+};
+
+/**
+ * How to extend the image.
+ * @member
+ * @private
+ */
+const extendWith = {
+  background: 'background',
+  copy: 'copy',
+  repeat: 'repeat',
+  mirror: 'mirror'
+};
+
+/**
+ * Strategies for automagic cover behaviour.
  * @member
  * @private
  */
@@ -37,76 +68,205 @@ const strategy = {
  */
 const kernel = {
   nearest: 'nearest',
+  linear: 'linear',
   cubic: 'cubic',
+  mitchell: 'mitchell',
   lanczos2: 'lanczos2',
-  lanczos3: 'lanczos3'
+  lanczos3: 'lanczos3',
+  mks2013: 'mks2013',
+  mks2021: 'mks2021'
 };
 
 /**
- * Enlargement interpolators.
+ * Methods by which an image can be resized to fit the provided dimensions.
  * @member
  * @private
  */
-const interpolator = {
-  nearest: 'nearest',
-  bilinear: 'bilinear',
-  bicubic: 'bicubic',
-  nohalo: 'nohalo',
-  lbb: 'lbb',
-  locallyBoundedBicubic: 'lbb',
-  vsqbs: 'vsqbs',
-  vertexSplitQuadraticBasisSpline: 'vsqbs'
+const fit = {
+  contain: 'contain',
+  cover: 'cover',
+  fill: 'fill',
+  inside: 'inside',
+  outside: 'outside'
 };
 
 /**
- * Resize image to `width` x `height`.
- * By default, the resized image is centre cropped to the exact size specified.
+ * Map external fit property to internal canvas property.
+ * @member
+ * @private
+ */
+const mapFitToCanvas = {
+  contain: 'embed',
+  cover: 'crop',
+  fill: 'ignore_aspect',
+  inside: 'max',
+  outside: 'min'
+};
+
+/**
+ * @private
+ */
+function isRotationExpected (options) {
+  return (options.angle % 360) !== 0 || options.input.autoOrient === true || options.rotationAngle !== 0;
+}
+
+/**
+ * @private
+ */
+function isResizeExpected (options) {
+  return options.width !== -1 || options.height !== -1;
+}
+
+/**
+ * Resize image to `width`, `height` or `width x height`.
  *
- * Possible reduction kernels are:
+ * 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).
  *
- * Possible enlargement interpolators are:
- * - `nearest`: Use [nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation).
- * - `bilinear`: Use [bilinear interpolation](http://en.wikipedia.org/wiki/Bilinear_interpolation), faster than bicubic but with less smooth results.
- * - `vertexSplitQuadraticBasisSpline`: Use the smoother [VSQBS interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/vsqbs.cpp#L48) to prevent "staircasing" when enlarging.
- * - `bicubic`: Use [bicubic interpolation](http://en.wikipedia.org/wiki/Bicubic_interpolation) (the default).
- * - `locallyBoundedBicubic`: Use [LBB interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/lbb.cpp#L100), which prevents some "[acutance](http://en.wikipedia.org/wiki/Acutance)" but typically reduces performance by a factor of 2.
- * - `nohalo`: Use [Nohalo interpolation](http://eprints.soton.ac.uk/268086/), which prevents acutance but typically reduces performance by a factor of 3.
+ * 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.
  *
  * @example
- * sharp(inputBuffer)
- *   .resize(200, 300, {
- *     kernel: sharp.kernel.lanczos2,
- *     interpolator: sharp.interpolator.nohalo
- *   })
- *   .background('white')
- *   .embed()
- *   .toFile('output.tiff')
- *   .then(function() {
- *     // output.tiff is a 200 pixels wide and 300 pixels high image
- *     // containing a lanczos2/nohalo scaled version, embedded on a white canvas,
- *     // of the image data in inputBuffer
+ * sharp(input)
+ *   .resize({ width: 100 })
+ *   .toBuffer()
+ *   .then(data => {
+ *     // 100 pixels wide, auto-scaled height
  *   });
  *
- * @param {Number} [width] - pixels wide the resultant image should be. Use `null` or `undefined` to auto-scale the width to match the height.
- * @param {Number} [height] - pixels high the resultant image should be. Use `null` or `undefined` to auto-scale the height to match the width.
+ * @example
+ * sharp(input)
+ *   .resize({ height: 100 })
+ *   .toBuffer()
+ *   .then(data => {
+ *     // 100 pixels high, auto-scaled width
+ *   });
+ *
+ * @example
+ * 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
+ * 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
+ * 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
+ * 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
+ * const scaleByHalf = await sharp(input)
+ *   .metadata()
+ *   .then(({ width }) => sharp(input)
+ *     .resize(Math.round(width * 0.5))
+ *     .toBuffer()
+ *   );
+ *
+ * @param {number} [width] - How many pixels wide the resultant image should be. Use `null` or `undefined` to auto-scale the width to match the height.
+ * @param {number} [height] - How many pixels high the resultant image should be. Use `null` or `undefined` to auto-scale the height to match the width.
  * @param {Object} [options]
- * @param {String} [options.kernel='lanczos3'] - the kernel to use for image reduction.
- * @param {String} [options.interpolator='bicubic'] - the interpolator to use for image enlargement.
- * @param {Boolean} [options.centreSampling=false] - use *magick centre sampling convention instead of corner sampling.
- * @param {Boolean} [options.centerSampling=false] - alternative spelling of centreSampling.
+ * @param {number} [options.width] - An alternative means of specifying `width`. If both are present this takes priority.
+ * @param {number} [options.height] - An alternative means of specifying `height`. If both are present this takes priority.
+ * @param {String} [options.fit='cover'] - How the image should be resized/cropped to fit the target dimension(s), one of `cover`, `contain`, `fill`, `inside` or `outside`.
+ * @param {String} [options.position='centre'] - A position, gravity or strategy to use when `fit` is `cover` or `contain`.
+ * @param {String|Object} [options.background={r: 0, g: 0, b: 0, alpha: 1}] - background colour when `fit` is `contain`, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to black without transparency.
+ * @param {String} [options.kernel='lanczos3'] - 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.
+ * @param {Boolean} [options.withoutEnlargement=false] - 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.
+ * @param {Boolean} [options.withoutReduction=false] - 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.
+ * @param {Boolean} [options.fastShrinkOnLoad=true] - 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.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-function resize (width, height, options) {
-  if (is.defined(width)) {
-    if (is.integer(width) && width > 0) {
-      this.options.width = width;
+function resize (widthOrOptions, height, options) {
+  if (isResizeExpected(this.options)) {
+    this.options.debuglog('ignoring previous resize options');
+  }
+  if (this.options.widthPost !== -1) {
+    this.options.debuglog('operation order will be: extract, resize, extract');
+  }
+  if (is.defined(widthOrOptions)) {
+    if (is.object(widthOrOptions) && !is.defined(options)) {
+      options = widthOrOptions;
+    } else if (is.integer(widthOrOptions) && widthOrOptions > 0) {
+      this.options.width = widthOrOptions;
     } else {
-      throw is.invalidParameterError('width', 'positive integer', width);
+      throw is.invalidParameterError('width', 'positive integer', widthOrOptions);
     }
   } else {
     this.options.width = -1;
@@ -121,6 +281,44 @@ function resize (width, height, options) {
     this.options.height = -1;
   }
   if (is.object(options)) {
+    // Width
+    if (is.defined(options.width)) {
+      if (is.integer(options.width) && options.width > 0) {
+        this.options.width = options.width;
+      } else {
+        throw is.invalidParameterError('width', 'positive integer', options.width);
+      }
+    }
+    // Height
+    if (is.defined(options.height)) {
+      if (is.integer(options.height) && options.height > 0) {
+        this.options.height = options.height;
+      } else {
+        throw is.invalidParameterError('height', 'positive integer', options.height);
+      }
+    }
+    // Fit
+    if (is.defined(options.fit)) {
+      const canvas = mapFitToCanvas[options.fit];
+      if (is.string(canvas)) {
+        this.options.canvas = canvas;
+      } else {
+        throw is.invalidParameterError('fit', 'valid fit', options.fit);
+      }
+    }
+    // Position
+    if (is.defined(options.position)) {
+      const pos = is.integer(options.position)
+        ? options.position
+        : strategy[options.position] || position[options.position] || gravity[options.position];
+      if (is.integer(pos) && (is.inRange(pos, 0, 8) || is.inRange(pos, 16, 17))) {
+        this.options.position = pos;
+      } else {
+        throw is.invalidParameterError('position', 'valid position/gravity/strategy', options.position);
+      }
+    }
+    // Background
+    this._setBackgroundColourOption('resizeBackground', options.background);
     // Kernel
     if (is.defined(options.kernel)) {
       if (is.string(kernel[options.kernel])) {
@@ -129,178 +327,264 @@ function resize (width, height, options) {
         throw is.invalidParameterError('kernel', 'valid kernel name', options.kernel);
       }
     }
-    // Interpolator
-    if (is.defined(options.interpolator)) {
-      if (is.string(interpolator[options.interpolator])) {
-        this.options.interpolator = interpolator[options.interpolator];
-      } else {
-        throw is.invalidParameterError('interpolator', 'valid interpolator name', options.interpolator);
-      }
+    // Without enlargement
+    if (is.defined(options.withoutEnlargement)) {
+      this._setBooleanOption('withoutEnlargement', options.withoutEnlargement);
     }
-    // Centre sampling
-    options.centreSampling = is.bool(options.centerSampling) ? options.centerSampling : options.centreSampling;
-    if (is.defined(options.centreSampling)) {
-      this._setBooleanOption('centreSampling', options.centreSampling);
+    // Without reduction
+    if (is.defined(options.withoutReduction)) {
+      this._setBooleanOption('withoutReduction', options.withoutReduction);
     }
+    // Shrink on load
+    if (is.defined(options.fastShrinkOnLoad)) {
+      this._setBooleanOption('fastShrinkOnLoad', options.fastShrinkOnLoad);
+    }
+  }
+  if (isRotationExpected(this.options) && isResizeExpected(this.options)) {
+    this.options.rotateBeforePreExtract = true;
   }
   return this;
 }
 
 /**
- * Crop the resized image to the exact size specified, the default behaviour.
- *
- * Possible attributes of the optional `sharp.gravity` are `north`, `northeast`, `east`, `southeast`, `south`,
- * `southwest`, `west`, `northwest`, `center` and `centre`.
- *
- * The experimental strategy-based approach 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.
+ * 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.
  *
  * @example
- * const transformer = sharp()
- *   .resize(200, 200)
- *   .crop(sharp.strategy.entropy)
- *   .on('error', function(err) {
- *     console.log(err);
- *   });
- * // Read image data from readableStream
- * // Write 200px square auto-cropped image data to writableStream
- * readableStream.pipe(transformer).pipe(writableStream);
+ * // 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 }
+ *   })
+ *   ...
  *
- * @param {String} [crop='centre'] - A member of `sharp.gravity` to crop to an edge/corner or `sharp.strategy` to crop dynamically.
+* @example
+ * // Add a row of 10 red pixels to the bottom
+ * sharp(input)
+ *   .extend({
+ *     bottom: 10,
+ *     background: 'red'
+ *   })
+ *   ...
+ *
+ * @example
+ * // Extrude image by 8 pixels to the right, mirroring existing right hand edge
+ * sharp(input)
+ *   .extend({
+ *     right: 8,
+ *     background: 'mirror'
+ *   })
+ *   ...
+ *
+ * @param {(number|Object)} extend - single pixel count to add to all edges or an Object with per-edge counts
+ * @param {number} [extend.top=0]
+ * @param {number} [extend.left=0]
+ * @param {number} [extend.bottom=0]
+ * @param {number} [extend.right=0]
+ * @param {String} [extend.extendWith='background'] - populate new pixels using this method, one of: background, copy, repeat, mirror.
+ * @param {String|Object} [extend.background={r: 0, g: 0, b: 0, alpha: 1}] - background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to black without transparency.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+*/
+function extend (extend) {
+  if (is.integer(extend) && extend > 0) {
+    this.options.extendTop = extend;
+    this.options.extendBottom = extend;
+    this.options.extendLeft = extend;
+    this.options.extendRight = extend;
+  } else if (is.object(extend)) {
+    if (is.defined(extend.top)) {
+      if (is.integer(extend.top) && extend.top >= 0) {
+        this.options.extendTop = extend.top;
+      } else {
+        throw is.invalidParameterError('top', 'positive integer', extend.top);
+      }
+    }
+    if (is.defined(extend.bottom)) {
+      if (is.integer(extend.bottom) && extend.bottom >= 0) {
+        this.options.extendBottom = extend.bottom;
+      } else {
+        throw is.invalidParameterError('bottom', 'positive integer', extend.bottom);
+      }
+    }
+    if (is.defined(extend.left)) {
+      if (is.integer(extend.left) && extend.left >= 0) {
+        this.options.extendLeft = extend.left;
+      } else {
+        throw is.invalidParameterError('left', 'positive integer', extend.left);
+      }
+    }
+    if (is.defined(extend.right)) {
+      if (is.integer(extend.right) && extend.right >= 0) {
+        this.options.extendRight = extend.right;
+      } else {
+        throw is.invalidParameterError('right', 'positive integer', extend.right);
+      }
+    }
+    this._setBackgroundColourOption('extendBackground', extend.background);
+    if (is.defined(extend.extendWith)) {
+      if (is.string(extendWith[extend.extendWith])) {
+        this.options.extendWith = extendWith[extend.extendWith];
+      } else {
+        throw is.invalidParameterError('extendWith', 'one of: background, copy, repeat, mirror', extend.extendWith);
+      }
+    }
+  } else {
+    throw is.invalidParameterError('extend', 'integer or object', extend);
+  }
+  return this;
+}
+
+/**
+ * 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.
+ *
+ * @example
+ * 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
+ * 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
+ *   });
+ *
+ * @param {Object} options - describes the region to extract using integral pixel values
+ * @param {number} options.left - zero-indexed offset from left edge
+ * @param {number} options.top - zero-indexed offset from top edge
+ * @param {number} options.width - width of region to extract
+ * @param {number} options.height - height of region to extract
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-function crop (crop) {
-  this.options.canvas = 'crop';
-  if (!is.defined(crop)) {
-    // Default
-    this.options.crop = gravity.center;
-  } else if (is.integer(crop) && is.inRange(crop, 0, 8)) {
-    // Gravity (numeric)
-    this.options.crop = crop;
-  } else if (is.string(crop) && is.integer(gravity[crop])) {
-    // Gravity (string)
-    this.options.crop = gravity[crop];
-  } else if (is.integer(crop) && crop >= strategy.entropy) {
-    // Strategy
-    this.options.crop = crop;
-  } else if (is.string(crop) && is.integer(strategy[crop])) {
-    // Strategy (string)
-    this.options.crop = strategy[crop];
-  } else {
-    throw is.invalidParameterError('crop', 'valid crop id/name/strategy', crop);
+function extract (options) {
+  const suffix = isResizeExpected(this.options) || this.options.widthPre !== -1 ? 'Post' : 'Pre';
+  if (this.options[`width${suffix}`] !== -1) {
+    this.options.debuglog('ignoring previous extract options');
+  }
+  ['left', 'top', 'width', 'height'].forEach(function (name) {
+    const value = options[name];
+    if (is.integer(value) && value >= 0) {
+      this.options[name + (name === 'left' || name === 'top' ? 'Offset' : '') + suffix] = value;
+    } else {
+      throw is.invalidParameterError(name, 'integer', value);
+    }
+  }, this);
+  // Ensure existing rotation occurs before pre-resize extraction
+  if (isRotationExpected(this.options) && !isResizeExpected(this.options)) {
+    if (this.options.widthPre === -1 || this.options.widthPost === -1) {
+      this.options.rotateBeforePreExtract = true;
+    }
   }
   return this;
 }
 
 /**
- * Preserving aspect ratio, resize the image to the maximum `width` or `height` specified
- * then embed on a background of the exact `width` and `height` specified.
+ * Trim pixels from all edges that contain values similar to the given background colour, which defaults to that of the top-left pixel.
  *
- * If the background contains an alpha value then WebP and PNG format output images will
- * contain an alpha channel, even when the input image does not.
+ * 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.
  *
  * @example
- * sharp('input.gif')
- *   .resize(200, 300)
- *   .background({r: 0, g: 0, b: 0, alpha: 0})
- *   .embed()
- *   .toFormat(sharp.format.webp)
- *   .toBuffer(function(err, outputBuffer) {
- *     if (err) {
- *       throw err;
- *     }
- *     // outputBuffer contains WebP image data of a 200 pixels wide and 300 pixels high
- *     // containing a scaled version, embedded on a transparent canvas, of input.gif
- *   });
- *
- * @returns {Sharp}
- */
-function embed () {
-  this.options.canvas = 'embed';
-  return this;
-}
-
-/**
- * Preserving aspect ratio, resize the image to be as large as possible
- * while ensuring its dimensions are less than or equal to the `width` and `height` specified.
- *
- * Both `width` and `height` must be provided via `resize` otherwise the behaviour will default to `crop`.
+ * // Trim pixels with a colour similar to that of the top-left pixel.
+ * await sharp(input)
+ *   .trim()
+ *   .toFile(output);
  *
  * @example
- * sharp(inputBuffer)
- *   .resize(200, 200)
- *   .max()
- *   .toFormat('jpeg')
- *   .toBuffer()
- *   .then(function(outputBuffer) {
- *     // outputBuffer contains JPEG image data no wider than 200 pixels and no higher
- *     // than 200 pixels regardless of the inputBuffer image dimensions
- *   });
+ * // Trim pixels with the exact same colour as that of the top-left pixel.
+ * await sharp(input)
+ *   .trim({
+ *     threshold: 0
+ *   })
+ *   .toFile(output);
  *
- * @returns {Sharp}
- */
-function max () {
-  this.options.canvas = 'max';
-  return this;
-}
-
-/**
- * Preserving aspect ratio, resize the image to be as small as possible
- * while ensuring its dimensions are greater than or equal to the `width` and `height` specified.
+ * @example
+ * // 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();
  *
- * Both `width` and `height` must be provided via `resize` otherwise the behaviour will default to `crop`.
+ * @example
+ * // Trim all "yellow-ish" pixels, being more lenient with the higher threshold.
+ * const output = await sharp(input)
+ *   .trim({
+ *     background: "yellow",
+ *     threshold: 42,
+ *   })
+ *   .toBuffer();
  *
+ * @param {Object} [options]
+ * @param {string|Object} [options.background='top-left pixel'] - Background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to that of the top-left pixel.
+ * @param {number} [options.threshold=10] - Allowed difference from the above colour, a positive number.
+ * @param {boolean} [options.lineArt=false] - Does the input more closely resemble line art (e.g. vector) rather than being photographic?
  * @returns {Sharp}
+ * @throws {Error} Invalid parameters
  */
-function min () {
-  this.options.canvas = 'min';
-  return this;
-}
-
-/**
- * Ignoring the aspect ratio of the input, stretch the image to
- * the exact `width` and/or `height` provided via `resize`.
- * @returns {Sharp}
- */
-function ignoreAspectRatio () {
-  this.options.canvas = 'ignore_aspect';
-  return this;
-}
-
-/**
- * Do not enlarge the output image if the input image width *or* height are already less than the required dimensions.
- * This is equivalent to GraphicsMagick's `>` geometry option:
- * "*change the dimensions of the image only if its width or height exceeds the geometry specification*".
- * @param {Boolean} [withoutEnlargement=true]
- * @returns {Sharp}
-*/
-function withoutEnlargement (withoutEnlargement) {
-  this.options.withoutEnlargement = is.bool(withoutEnlargement) ? withoutEnlargement : true;
+function trim (options) {
+  this.options.trimThreshold = 10;
+  if (is.defined(options)) {
+    if (is.object(options)) {
+      if (is.defined(options.background)) {
+        this._setBackgroundColourOption('trimBackground', options.background);
+      }
+      if (is.defined(options.threshold)) {
+        if (is.number(options.threshold) && options.threshold >= 0) {
+          this.options.trimThreshold = options.threshold;
+        } else {
+          throw is.invalidParameterError('threshold', 'positive number', options.threshold);
+        }
+      }
+      if (is.defined(options.lineArt)) {
+        this._setBooleanOption('trimLineArt', options.lineArt);
+      }
+    } else {
+      throw is.invalidParameterError('trim', 'object', options);
+    }
+  }
+  if (isRotationExpected(this.options)) {
+    this.options.rotateBeforePreExtract = true;
+  }
   return this;
 }
 
 /**
  * Decorate the Sharp prototype with resize-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {
-  [
+  Object.assign(Sharp.prototype, {
     resize,
-    crop,
-    embed,
-    max,
-    min,
-    ignoreAspectRatio,
-    withoutEnlargement
-  ].forEach(function (f) {
-    Sharp.prototype[f.name] = f;
+    extend,
+    extract,
+    trim
   });
   // Class attributes
   Sharp.gravity = gravity;
   Sharp.strategy = strategy;
   Sharp.kernel = kernel;
-  Sharp.interpolator = interpolator;
+  Sharp.fit = fit;
+  Sharp.position = position;
 };

lib/sharp.js

@@ -0,0 +1,122 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
+'use strict';
+
+// Inspects the runtime environment and exports the relevant sharp.node binary
+
+const { familySync, versionSync } = require('detect-libc');
+
+const { runtimePlatformArch, isUnsupportedNodeRuntime, prebuiltPlatforms, minimumLibvipsVersion } = require('./libvips');
+const runtimePlatform = runtimePlatformArch();
+
+const paths = [
+  `../src/build/Release/sharp-${runtimePlatform}.node`,
+  '../src/build/Release/sharp-wasm32.node',
+  `@img/sharp-${runtimePlatform}/sharp.node`,
+  '@img/sharp-wasm32/sharp.node'
+];
+
+let path, sharp;
+const errors = [];
+for (path of paths) {
+  try {
+    sharp = require(path);
+    break;
+  } catch (err) {
+    /* istanbul ignore next */
+    errors.push(err);
+  }
+}
+
+/* istanbul ignore next */
+if (sharp && path.startsWith('@img/sharp-linux-x64') && !sharp._isUsingX64V2()) {
+  const err = new Error('Prebuilt binaries for linux-x64 require v2 microarchitecture');
+  err.code = 'Unsupported CPU';
+  errors.push(err);
+  sharp = null;
+}
+
+/* istanbul ignore next */
+if (sharp) {
+  module.exports = sharp;
+} else {
+  const [isLinux, isMacOs, isWindows] = ['linux', 'darwin', 'win32'].map(os => runtimePlatform.startsWith(os));
+
+  const help = [`Could not load the "sharp" module using the ${runtimePlatform} runtime`];
+  errors.forEach(err => {
+    if (err.code !== 'MODULE_NOT_FOUND') {
+      help.push(`${err.code}: ${err.message}`);
+    }
+  });
+  const messages = errors.map(err => err.message).join(' ');
+  help.push('Possible solutions:');
+  // Common error messages
+  if (isUnsupportedNodeRuntime()) {
+    const { found, expected } = isUnsupportedNodeRuntime();
+    help.push(
+      '- Please upgrade Node.js:',
+      `    Found ${found}`,
+      `    Requires ${expected}`
+    );
+  } else if (prebuiltPlatforms.includes(runtimePlatform)) {
+    const [os, cpu] = runtimePlatform.split('-');
+    const libc = os.endsWith('musl') ? ' --libc=musl' : '';
+    help.push(
+      '- Ensure optional dependencies can be installed:',
+      '    npm install --include=optional sharp',
+      '- Ensure your package manager supports multi-platform installation:',
+      '    See https://sharp.pixelplumbing.com/install#cross-platform',
+      '- Add platform-specific dependencies:',
+      `    npm install --os=${os.replace('musl', '')}${libc} --cpu=${cpu} sharp`
+    );
+  } else {
+    help.push(
+      `- Manually install libvips >= ${minimumLibvipsVersion}`,
+      '- Add experimental WebAssembly-based dependencies:',
+      '    npm install --cpu=wasm32 sharp',
+      '    npm install @img/sharp-wasm32'
+    );
+  }
+  if (isLinux && /(symbol not found|CXXABI_)/i.test(messages)) {
+    try {
+      const { config } = require(`@img/sharp-libvips-${runtimePlatform}/package`);
+      const libcFound = `${familySync()} ${versionSync()}`;
+      const libcRequires = `${config.musl ? 'musl' : 'glibc'} ${config.musl || config.glibc}`;
+      help.push(
+        '- Update your OS:',
+        `    Found ${libcFound}`,
+        `    Requires ${libcRequires}`
+      );
+    } catch (errEngines) {}
+  }
+  if (isLinux && /\/snap\/core[0-9]{2}/.test(messages)) {
+    help.push(
+      '- Remove the Node.js Snap, which does not support native modules',
+      '    snap remove node'
+    );
+  }
+  if (isMacOs && /Incompatible library version/.test(messages)) {
+    help.push(
+      '- Update Homebrew:',
+      '    brew update && brew upgrade vips'
+    );
+  }
+  if (errors.some(err => err.code === 'ERR_DLOPEN_DISABLED')) {
+    help.push('- Run Node.js without using the --no-addons flag');
+  }
+  // Link to installation docs
+  if (isWindows && /The specified procedure could not be found/.test(messages)) {
+    help.push(
+      '- Using the canvas package on Windows?',
+      '    See https://sharp.pixelplumbing.com/install#canvas-and-windows',
+      '- Check for outdated versions of sharp in the dependency tree:',
+      '    npm ls sharp'
+    );
+  }
+  help.push(
+    '- Consult the installation documentation:',
+    '    See https://sharp.pixelplumbing.com/install'
+  );
+  throw new Error(help.join('\n'));
+}

lib/utility.js

@@ -1,10 +1,89 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
 'use strict';
 
+const events = require('node:events');
+const detectLibc = require('detect-libc');
+
 const is = require('./is');
-const sharp = require('../build/Release/sharp.node');
+const { runtimePlatformArch } = require('./libvips');
+const sharp = require('./sharp');
+
+const runtimePlatform = runtimePlatformArch();
+const libvipsVersion = sharp.libvipsVersion();
 
 /**
- * Gets, or when options are provided sets, the limits of _libvips'_ operation cache.
+ * An Object containing nested boolean values representing the available input and output formats/methods.
+ * @member
+ * @example
+ * console.log(sharp.format);
+ * @returns {Object}
+ */
+const format = sharp.format();
+format.heif.output.alias = ['avif', 'heic'];
+format.jpeg.output.alias = ['jpe', 'jpg'];
+format.tiff.output.alias = ['tif'];
+format.jp2k.output.alias = ['j2c', 'j2k', 'jp2', 'jpx'];
+
+/**
+ * An Object containing the available interpolators and their proper values
+ * @readonly
+ * @enum {string}
+ */
+const interpolators = {
+  /** [Nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation). Suitable for image enlargement only. */
+  nearest: 'nearest',
+  /** [Bilinear interpolation](http://en.wikipedia.org/wiki/Bilinear_interpolation). Faster than bicubic but with less smooth results. */
+  bilinear: 'bilinear',
+  /** [Bicubic interpolation](http://en.wikipedia.org/wiki/Bicubic_interpolation) (the default). */
+  bicubic: 'bicubic',
+  /** [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. */
+  locallyBoundedBicubic: 'lbb',
+  /** [Nohalo interpolation](http://eprints.soton.ac.uk/268086/). Prevents acutance but typically reduces performance by a factor of 3. */
+  nohalo: 'nohalo',
+  /** [VSQBS interpolation](https://github.com/libvips/libvips/blob/master/libvips/resample/vsqbs.cpp#L48). Prevents "staircasing" when enlarging. */
+  vertexSplitQuadraticBasisSpline: 'vsqbs'
+};
+
+/**
+ * An Object containing the version numbers of sharp, libvips
+ * and (when using prebuilt binaries) its dependencies.
+ *
+ * @member
+ * @example
+ * console.log(sharp.versions);
+ */
+let versions = {
+  vips: libvipsVersion.semver
+};
+/* istanbul ignore next */
+if (!libvipsVersion.isGlobal) {
+  if (!libvipsVersion.isWasm) {
+    try {
+      versions = require(`@img/sharp-${runtimePlatform}/versions`);
+    } catch (_) {
+      try {
+        versions = require(`@img/sharp-libvips-${runtimePlatform}/versions`);
+      } catch (_) {}
+    }
+  } else {
+    try {
+      versions = require('@img/sharp-wasm32/versions');
+    } catch (_) {}
+  }
+}
+versions.sharp = require('../package.json').version;
+
+/* istanbul ignore next */
+if (versions.heif && format.heif) {
+  // Prebuilt binaries provide AV1
+  format.heif.input.fileSuffix = ['.avif'];
+  format.heif.output.alias = ['avif'];
+}
+
+/**
+ * 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.
@@ -16,10 +95,10 @@ const sharp = require('../build/Release/sharp.node');
  * sharp.cache( { files: 0 } );
  * sharp.cache(false);
  *
- * @param {Object|Boolean} options - Object with the following attributes, or Boolean where true uses default cache settings and false removes all caching.
- * @param {Number} [options.memory=50] - is the maximum memory in MB to use for this cache
- * @param {Number} [options.files=20] - is the maximum number of files to hold open
- * @param {Number} [options.items=100] - is the maximum number of operations to cache
+ * @param {Object|boolean} [options=true] - Object with the following attributes, or boolean where true uses default cache settings and false removes all caching
+ * @param {number} [options.memory=50] - is the maximum memory in MB to use for this cache
+ * @param {number} [options.files=20] - is the maximum number of files to hold open
+ * @param {number} [options.items=100] - is the maximum number of operations to cache
  * @returns {Object}
  */
 function cache (options) {
@@ -39,27 +118,64 @@ function cache (options) {
 cache(true);
 
 /**
- * Gets, or when a concurrency is provided sets,
- * the number of threads _libvips'_ should create to process each image.
- * The default value is the number of CPU cores.
- * A value of `0` will reset to this default.
- *
- * The maximum number of images that can be processed in parallel
- * is limited by libuv's `UV_THREADPOOL_SIZE` environment variable.
+ * 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.
+ *
+ * The maximum number of images that sharp can process in parallel
+ * is controlled by libuv's `UV_THREADPOOL_SIZE` environment variable,
+ * which defaults to 4.
+ *
+ * https://nodejs.org/api/cli.html#uv_threadpool_sizesize
+ *
+ * For example, by default, a machine with 8 CPU cores will process
+ * 4 images in parallel and use up to 8 threads per image,
+ * so there will be up to 32 concurrent threads.
+ *
  * @example
  * const threads = sharp.concurrency(); // 4
  * sharp.concurrency(2); // 2
  * sharp.concurrency(0); // 4
  *
- * @param {Number} [concurrency]
- * @returns {Number} concurrency
+ * @param {number} [concurrency]
+ * @returns {number} concurrency
  */
 function concurrency (concurrency) {
   return sharp.concurrency(is.integer(concurrency) ? concurrency : null);
 }
+/* istanbul ignore next */
+if (detectLibc.familySync() === detectLibc.GLIBC && !sharp._isUsingJemalloc()) {
+  // Reduce default concurrency to 1 when using glibc memory allocator
+  sharp.concurrency(1);
+} else if (detectLibc.familySync() === detectLibc.MUSL && sharp.concurrency() === 1024) {
+  // Reduce default concurrency when musl thread over-subscription detected
+  sharp.concurrency(require('node:os').availableParallelism());
+}
+
+/**
+ * An EventEmitter that emits a `change` event when a task is either:
+ * - queued, waiting for _libuv_ to provide a worker thread
+ * - complete
+ * @member
+ * @example
+ * sharp.queue.on('change', function(queueLength) {
+ *   console.log('Queue contains ' + queueLength + ' task(s)');
+ * });
+ */
+const queue = new events.EventEmitter();
 
 /**
  * Provides access to internal task counters.
@@ -77,40 +193,105 @@ function counters () {
 
 /**
  * Get and set use of SIMD vector unit instructions.
- * Requires libvips to have been compiled with liborc support.
+ * 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.
  *
- * This feature is currently off by default but future versions may reverse this.
- * Versions of liborc prior to 0.4.25 are known to segfault under heavy load.
- *
  * @example
  * const simd = sharp.simd();
- * // simd is `true` if SIMD is currently enabled
+ * // simd is `true` if the runtime use of highway is currently enabled
  * @example
- * const simd = sharp.simd(true);
- * // attempts to enable the use of SIMD, returning true if available
+ * const simd = sharp.simd(false);
+ * // prevent libvips from using highway at runtime
  *
- * @param {Boolean} [simd=false]
- * @returns {Boolean}
+ * @param {boolean} [simd=true]
+ * @returns {boolean}
  */
 function simd (simd) {
   return sharp.simd(is.bool(simd) ? simd : null);
 }
-simd(false);
+
+/**
+ * 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
+ *
+ * @example <caption>Block all TIFF input.</caption>
+ * sharp.block({
+ *   operation: ['VipsForeignLoadTiff']
+ * });
+ *
+ * @param {Object} options
+ * @param {Array<string>} options.operation - List of libvips low-level operation names to block.
+ */
+function block (options) {
+  if (is.object(options)) {
+    if (Array.isArray(options.operation) && options.operation.every(is.string)) {
+      sharp.block(options.operation, true);
+    } else {
+      throw is.invalidParameterError('operation', 'Array<string>', options.operation);
+    }
+  } else {
+    throw is.invalidParameterError('options', 'object', options);
+  }
+}
+
+/**
+ * Unblock libvips operations at runtime.
+ *
+ * This is useful for defining a list of allowed operations.
+ *
+ * @since 0.32.4
+ *
+ * @example <caption>Block all input except WebP from the filesystem.</caption>
+ * sharp.block({
+ *   operation: ['VipsForeignLoad']
+ * });
+ * sharp.unblock({
+ *   operation: ['VipsForeignLoadWebpFile']
+ * });
+ *
+ * @example <caption>Block all input except JPEG and PNG from a Buffer or Stream.</caption>
+ * sharp.block({
+ *   operation: ['VipsForeignLoad']
+ * });
+ * sharp.unblock({
+ *   operation: ['VipsForeignLoadJpegBuffer', 'VipsForeignLoadPngBuffer']
+ * });
+ *
+ * @param {Object} options
+ * @param {Array<string>} options.operation - List of libvips low-level operation names to unblock.
+ */
+function unblock (options) {
+  if (is.object(options)) {
+    if (Array.isArray(options.operation) && options.operation.every(is.string)) {
+      sharp.block(options.operation, false);
+    } else {
+      throw is.invalidParameterError('operation', 'Array<string>', options.operation);
+    }
+  } else {
+    throw is.invalidParameterError('options', 'object', options);
+  }
+}
 
 /**
  * Decorate the Sharp class with utility-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {
-  [
-    cache,
-    concurrency,
-    counters,
-    simd
-  ].forEach(function (f) {
-    Sharp[f.name] = f;
-  });
+  Sharp.cache = cache;
+  Sharp.concurrency = concurrency;
+  Sharp.counters = counters;
+  Sharp.simd = simd;
+  Sharp.format = format;
+  Sharp.interpolators = interpolators;
+  Sharp.versions = versions;
+  Sharp.queue = queue;
+  Sharp.block = block;
+  Sharp.unblock = unblock;
 };

mkdocs.yml

@@ -1,25 +0,0 @@
-site_name: sharp
-site_url: http://sharp.pixelplumbing.com/
-repo_url: https://github.com/lovell/sharp
-site_description: High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP and TIFF images
-copyright: <a href="https://pixelplumbing.com/">pixelplumbing.com</a>
-google_analytics: ['UA-13034748-12', 'sharp.pixelplumbing.com']
-theme: readthedocs
-markdown_extensions:
-  - toc:
-      permalink: True
-pages:
-  - Home: index.md
-  - Installation: install.md
-  - API:
-    - Constructor: api-constructor.md
-    - Input: api-input.md
-    - Output: api-output.md
-    - "Resizing images": api-resize.md
-    - "Compositing images": api-composite.md
-    - "Image operations": api-operation.md
-    - "Colour manipulation": api-colour.md
-    - "Channel manipulation": api-channel.md
-    - Utilities: api-utility.md
-  - Performance: performance.md
-  - Changelog: changelog.md

npm/darwin-arm64/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@img/sharp-darwin-arm64",
+  "version": "0.34.2-rc.0",
+  "description": "Prebuilt sharp for use with macOS 64-bit ARM",
+  "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://sharp.pixelplumbing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovell/sharp.git",
+    "directory": "npm/darwin-arm64"
+  },
+  "license": "Apache-2.0",
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "preferUnplugged": true,
+  "optionalDependencies": {
+    "@img/sharp-libvips-darwin-arm64": "1.1.0"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./sharp.node": "./lib/sharp-darwin-arm64.node",
+    "./package": "./package.json"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "os": [
+    "darwin"
+  ],
+  "cpu": [
+    "arm64"
+  ]
+}

npm/darwin-x64/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@img/sharp-darwin-x64",
+  "version": "0.34.2-rc.0",
+  "description": "Prebuilt sharp for use with macOS x64",
+  "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://sharp.pixelplumbing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovell/sharp.git",
+    "directory": "npm/darwin-x64"
+  },
+  "license": "Apache-2.0",
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "preferUnplugged": true,
+  "optionalDependencies": {
+    "@img/sharp-libvips-darwin-x64": "1.1.0"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./sharp.node": "./lib/sharp-darwin-x64.node",
+    "./package": "./package.json"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "os": [
+    "darwin"
+  ],
+  "cpu": [
+    "x64"
+  ]
+}

npm/from-github-release.js

@@ -0,0 +1,73 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
+'use strict';
+
+// Populate contents of all packages with the current GitHub release
+
+const { readFile, writeFile, appendFile, copyFile, rm } = require('node:fs/promises');
+const path = require('node:path');
+const { Readable } = require('node:stream');
+const { pipeline } = require('node:stream/promises');
+const { createGunzip } = require('node:zlib');
+const { extract } = require('tar-fs');
+
+const { workspaces } = require('./package.json');
+const { version } = require('../package.json');
+
+const mapTarballEntry = (header) => {
+  header.name = path.basename(header.name);
+  return header;
+};
+
+const licensing = `
+## 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.
+`;
+
+workspaces.map(async platform => {
+  const prebuildPlatform = platform === 'wasm32' ? 'emscripten-wasm32' : platform;
+  const url = `https://github.com/lovell/sharp/releases/download/v${version}/sharp-v${version}-napi-v9-${prebuildPlatform}.tar.gz`;
+  const dir = path.join(__dirname, platform);
+  const response = await fetch(url);
+  if (!response.ok) {
+    console.log(`Skipping ${platform}: ${response.statusText}`);
+    return;
+  }
+  // Extract prebuild tarball
+  const lib = path.join(dir, 'lib');
+  await rm(lib, { force: true, recursive: true });
+  await pipeline(
+    Readable.fromWeb(response.body),
+    createGunzip(),
+    extract(lib, { map: mapTarballEntry })
+  );
+  // Generate README
+  const { name, description } = require(`./${platform}/package.json`);
+  await writeFile(path.join(dir, 'README.md'), `# \`${name}\`\n\n${description}.\n${licensing}`);
+  // Copy Apache-2.0 LICENSE
+  await copyFile(path.join(__dirname, '..', 'LICENSE'), path.join(dir, 'LICENSE'));
+  // Copy files for packages without an explicit sharp-libvips dependency (Windows, wasm)
+  if (platform.startsWith('win') || platform.startsWith('wasm')) {
+    const libvipsPlatform = platform === 'wasm32' ? 'dev-wasm32' : platform;
+    const sharpLibvipsDir = path.join(require(`@img/sharp-libvips-${libvipsPlatform}/lib`), '..');
+    // Copy versions.json
+    await copyFile(path.join(sharpLibvipsDir, 'versions.json'), path.join(dir, 'versions.json'));
+    // Append third party licensing to README
+    const readme = await readFile(path.join(sharpLibvipsDir, 'README.md'), { encoding: 'utf-8' });
+    const thirdParty = readme.substring(readme.indexOf('\nThis software contains'));
+    appendFile(path.join(dir, 'README.md'), thirdParty);
+  }
+});

npm/from-local-build.js

@@ -0,0 +1,26 @@
+// Copyright 2013 Lovell Fuller and others.
+// SPDX-License-Identifier: Apache-2.0
+
+'use strict';
+
+// Populate contents of a single npm/sharpen-sharp-<build-platform> package
+// with the local/CI build directory for local/CI prebuild testing
+
+const fs = require('node:fs');
+const path = require('node:path');
+
+const { buildPlatformArch } = require('../lib/libvips');
+const platform = buildPlatformArch();
+const dest = path.join(__dirname, platform);
+
+// Use same config as prebuild to copy binary files
+const release = path.join(__dirname, '..', 'src', 'build', 'Release');
+const prebuildrc = JSON.parse(fs.readFileSync(path.join(__dirname, '..', '.prebuildrc'), 'utf8'));
+const include = new RegExp(prebuildrc['include-regex'], 'i');
+fs.cpSync(release, path.join(dest, 'lib'), {
+  recursive: true,
+  filter: (file) => {
+    const name = path.basename(file);
+    return name === 'Release' || include.test(name);
+  }
+});

npm/linux-arm/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@img/sharp-linux-arm",
+  "version": "0.34.2-rc.0",
+  "description": "Prebuilt sharp for use with Linux (glibc) ARM (32-bit)",
+  "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://sharp.pixelplumbing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovell/sharp.git",
+    "directory": "npm/linux-arm"
+  },
+  "license": "Apache-2.0",
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "preferUnplugged": true,
+  "optionalDependencies": {
+    "@img/sharp-libvips-linux-arm": "1.1.0"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./sharp.node": "./lib/sharp-linux-arm.node",
+    "./package": "./package.json"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
+    "glibc": ">=2.31"
+  },
+  "os": [
+    "linux"
+  ],
+  "libc": [
+    "glibc"
+  ],
+  "cpu": [
+    "arm"
+  ]
+}

npm/linux-arm64/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@img/sharp-linux-arm64",
+  "version": "0.34.2-rc.0",
+  "description": "Prebuilt sharp for use with Linux (glibc) 64-bit ARM",
+  "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://sharp.pixelplumbing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovell/sharp.git",
+    "directory": "npm/linux-arm64"
+  },
+  "license": "Apache-2.0",
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "preferUnplugged": true,
+  "optionalDependencies": {
+    "@img/sharp-libvips-linux-arm64": "1.1.0"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./sharp.node": "./lib/sharp-linux-arm64.node",
+    "./package": "./package.json"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
+    "glibc": ">=2.26"
+  },
+  "os": [
+    "linux"
+  ],
+  "libc": [
+    "glibc"
+  ],
+  "cpu": [
+    "arm64"
+  ]
+}

npm/linux-ppc64/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@img/sharp-linux-ppc64",
+  "version": "0.34.2-rc.0",
+  "description": "Prebuilt sharp for use with Linux (glibc) ppc64",
+  "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://sharp.pixelplumbing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovell/sharp.git",
+    "directory": "npm/linux-ppc64"
+  },
+  "license": "Apache-2.0",
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "preferUnplugged": true,
+  "optionalDependencies": {
+    "@img/sharp-libvips-linux-ppc64": "1.1.0"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./sharp.node": "./lib/sharp-linux-ppc64.node",
+    "./package": "./package.json"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
+    "glibc": ">=2.31"
+  },
+  "os": [
+    "linux"
+  ],
+  "libc": [
+    "glibc"
+  ],
+  "cpu": [
+    "ppc64"
+  ]
+}

npm/linux-s390x/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@img/sharp-linux-s390x",
+  "version": "0.34.2-rc.0",
+  "description": "Prebuilt sharp for use with Linux (glibc) s390x",
+  "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://sharp.pixelplumbing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovell/sharp.git",
+    "directory": "npm/linux-s390x"
+  },
+  "license": "Apache-2.0",
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "preferUnplugged": true,
+  "optionalDependencies": {
+    "@img/sharp-libvips-linux-s390x": "1.1.0"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./sharp.node": "./lib/sharp-linux-s390x.node",
+    "./package": "./package.json"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
+    "glibc": ">=2.31"
+  },
+  "os": [
+    "linux"
+  ],
+  "libc": [
+    "glibc"
+  ],
+  "cpu": [
+    "s390x"
+  ]
+}

npm/linux-x64/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@img/sharp-linux-x64",
+  "version": "0.34.2-rc.0",
+  "description": "Prebuilt sharp for use with Linux (glibc) x64",
+  "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://sharp.pixelplumbing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovell/sharp.git",
+    "directory": "npm/linux-x64"
+  },
+  "license": "Apache-2.0",
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "preferUnplugged": true,
+  "optionalDependencies": {
+    "@img/sharp-libvips-linux-x64": "1.1.0"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./sharp.node": "./lib/sharp-linux-x64.node",
+    "./package": "./package.json"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
+    "glibc": ">=2.26"
+  },
+  "os": [
+    "linux"
+  ],
+  "libc": [
+    "glibc"
+  ],
+  "cpu": [
+    "x64"
+  ]
+}

npm/linuxmusl-arm64/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@img/sharp-linuxmusl-arm64",
+  "version": "0.34.2-rc.0",
+  "description": "Prebuilt sharp for use with Linux (musl) 64-bit ARM",
+  "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://sharp.pixelplumbing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovell/sharp.git",
+    "directory": "npm/linuxmusl-arm64"
+  },
+  "license": "Apache-2.0",
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "preferUnplugged": true,
+  "optionalDependencies": {
+    "@img/sharp-libvips-linuxmusl-arm64": "1.1.0"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./sharp.node": "./lib/sharp-linuxmusl-arm64.node",
+    "./package": "./package.json"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
+    "musl": ">=1.2.2"
+  },
+  "os": [
+    "linux"
+  ],
+  "libc": [
+    "musl"
+  ],
+  "cpu": [
+    "arm64"
+  ]
+}

npm/linuxmusl-x64/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@img/sharp-linuxmusl-x64",
+  "version": "0.34.2-rc.0",
+  "description": "Prebuilt sharp for use with Linux (musl) x64",
+  "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://sharp.pixelplumbing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovell/sharp.git",
+    "directory": "npm/linuxmusl-x64"
+  },
+  "license": "Apache-2.0",
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "preferUnplugged": true,
+  "optionalDependencies": {
+    "@img/sharp-libvips-linuxmusl-x64": "1.1.0"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./sharp.node": "./lib/sharp-linuxmusl-x64.node",
+    "./package": "./package.json"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
+    "musl": ">=1.2.2"
+  },
+  "os": [
+    "linux"
+  ],
+  "libc": [
+    "musl"
+  ],
+  "cpu": [
+    "x64"
+  ]
+}

npm/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@img/sharp",
+  "version": "0.34.2-rc.0",
+  "private": "true",
+  "workspaces": [
+    "darwin-arm64",
+    "darwin-x64",
+    "linux-arm",
+    "linux-arm64",
+    "linux-ppc64",
+    "linux-s390x",
+    "linux-x64",
+    "linuxmusl-arm64",
+    "linuxmusl-x64",
+    "wasm32",
+    "win32-arm64",
+    "win32-ia32",
+    "win32-x64"
+  ]
+}

npm/wasm32/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@img/sharp-wasm32",
+  "version": "0.34.2-rc.0",
+  "description": "Prebuilt sharp for use with wasm32",
+  "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://sharp.pixelplumbing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovell/sharp.git",
+    "directory": "npm/wasm32"
+  },
+  "license": "Apache-2.0 AND LGPL-3.0-or-later AND MIT",
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "preferUnplugged": true,
+  "files": [
+    "lib",
+    "versions.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./sharp.node": "./lib/sharp-wasm32.node.js",
+    "./package": "./package.json",
+    "./versions": "./versions.json"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "dependencies": {
+    "@emnapi/runtime": "^1.4.3"
+  },
+  "cpu": [
+    "wasm32"
+  ]
+}

npm/win32-arm64/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@img/sharp-win32-arm64",
+  "version": "0.34.2-rc.0",
+  "description": "Prebuilt sharp for use with Windows 64-bit ARM",
+  "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://sharp.pixelplumbing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovell/sharp.git",
+    "directory": "npm/win32-arm64"
+  },
+  "license": "Apache-2.0 AND LGPL-3.0-or-later",
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "preferUnplugged": true,
+  "files": [
+    "lib",
+    "versions.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./sharp.node": "./lib/sharp-win32-arm64.node",
+    "./package": "./package.json",
+    "./versions": "./versions.json"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "os": [
+    "win32"
+  ],
+  "cpu": [
+    "arm64"
+  ]
+}

npm/win32-ia32/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@img/sharp-win32-ia32",
+  "version": "0.34.2-rc.0",
+  "description": "Prebuilt sharp for use with Windows x86 (32-bit)",
+  "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://sharp.pixelplumbing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovell/sharp.git",
+    "directory": "npm/win32-ia32"
+  },
+  "license": "Apache-2.0 AND LGPL-3.0-or-later",
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "preferUnplugged": true,
+  "files": [
+    "lib",
+    "versions.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./sharp.node": "./lib/sharp-win32-ia32.node",
+    "./package": "./package.json",
+    "./versions": "./versions.json"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "os": [
+    "win32"
+  ],
+  "cpu": [
+    "ia32"
+  ]
+}

npm/win32-x64/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@img/sharp-win32-x64",
+  "version": "0.34.2-rc.0",
+  "description": "Prebuilt sharp for use with Windows x64",
+  "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://sharp.pixelplumbing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovell/sharp.git",
+    "directory": "npm/win32-x64"
+  },
+  "license": "Apache-2.0 AND LGPL-3.0-or-later",
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "preferUnplugged": true,
+  "files": [
+    "lib",
+    "versions.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./sharp.node": "./lib/sharp-win32-x64.node",
+    "./package": "./package.json",
+    "./versions": "./versions.json"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "os": [
+    "win32"
+  ],
+  "cpu": [
+    "x64"
+  ]
+}

package.json

@@ -1,9 +1,9 @@
 {
   "name": "sharp",
-  "description": "High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP and TIFF images",
-  "version": "0.18.1",
+  "description": "High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP, GIF, AVIF and TIFF images",
+  "version": "0.34.2-rc.0",
   "author": "Lovell Fuller <npm@lovell.info>",
-  "homepage": "https://github.com/lovell/sharp",
+  "homepage": "https://sharp.pixelplumbing.com",
   "contributors": [
     "Pierre Inglebert <pierre.inglebert@gmail.com>",
     "Jonathan Ong <jonathanrichardong@gmail.com>",
@@ -37,61 +37,170 @@
     "Kristo Jorgenson <kristo.jorgenson@gmail.com>",
     "YvesBos <yves_bos@outlook.com>",
     "Guy Maliar <guy@tailorbrands.com>",
-    "Nicolas Coden <nicolas@ncoden.fr>"
+    "Nicolas Coden <nicolas@ncoden.fr>",
+    "Matt Parrish <matt.r.parrish@gmail.com>",
+    "Marcel Bretschneider <marcel.bretschneider@gmail.com>",
+    "Matthew McEachen <matthew+github@mceachen.org>",
+    "Jarda Kotěšovec <jarda.kotesovec@gmail.com>",
+    "Kenric D'Souza <kenric.dsouza@gmail.com>",
+    "Oleh Aleinyk <oleg.aleynik@gmail.com>",
+    "Marcel Bretschneider <marcel.bretschneider@gmail.com>",
+    "Andrea Bianco <andrea.bianco@unibas.ch>",
+    "Rik Heywood <rik@rik.org>",
+    "Thomas Parisot <hi@oncletom.io>",
+    "Nathan Graves <nathanrgraves+github@gmail.com>",
+    "Tom Lokhorst <tom@lokhorst.eu>",
+    "Espen Hovlandsdal <espen@hovlandsdal.com>",
+    "Sylvain Dumont <sylvain.dumont35@gmail.com>",
+    "Alun Davies <alun.owain.davies@googlemail.com>",
+    "Aidan Hoolachan <ajhoolachan21@gmail.com>",
+    "Axel Eirola <axel.eirola@iki.fi>",
+    "Freezy <freezy@xbmc.org>",
+    "Daiz <taneli.vatanen@gmail.com>",
+    "Julian Aubourg <j@ubourg.net>",
+    "Keith Belovay <keith@picthrive.com>",
+    "Michael B. Klein <mbklein@gmail.com>",
+    "Jordan Prudhomme <jordan@raboland.fr>",
+    "Ilya Ovdin <iovdin@gmail.com>",
+    "Andargor <andargor@yahoo.com>",
+    "Paul Neave <paul.neave@gmail.com>",
+    "Brendan Kennedy <brenwken@gmail.com>",
+    "Brychan Bennett-Odlum <git@brychan.io>",
+    "Edward Silverton <e.silverton@gmail.com>",
+    "Roman Malieiev <aromaleev@gmail.com>",
+    "Tomas Szabo <tomas.szabo@deftomat.com>",
+    "Robert O'Rourke <robert@o-rourke.org>",
+    "Guillermo Alfonso Varela Chouciño <guillevch@gmail.com>",
+    "Christian Flintrup <chr@gigahost.dk>",
+    "Manan Jadhav <manan@motionden.com>",
+    "Leon Radley <leon@radley.se>",
+    "alza54 <alza54@thiocod.in>",
+    "Jacob Smith <jacob@frende.me>",
+    "Michael Nutt <michael@nutt.im>",
+    "Brad Parham <baparham@gmail.com>",
+    "Taneli Vatanen <taneli.vatanen@gmail.com>",
+    "Joris Dugué <zaruike10@gmail.com>",
+    "Chris Banks <christopher.bradley.banks@gmail.com>",
+    "Ompal Singh <ompal.hitm09@gmail.com>",
+    "Brodan <christopher.hranj@gmail.com>",
+    "Ankur Parihar <ankur.github@gmail.com>",
+    "Brahim Ait elhaj <brahima@gmail.com>",
+    "Mart Jansink <m.jansink@gmail.com>",
+    "Lachlan Newman <lachnewman007@gmail.com>",
+    "Dennis Beatty <dennis@dcbeatty.com>",
+    "Ingvar Stepanyan <me@rreverser.com>",
+    "Don Denton <don@happycollision.com>"
   ],
   "scripts": {
-    "clean": "rm -rf node_modules/ build/ vendor/ coverage/ test/fixtures/output.*",
-    "test": "semistandard && cc && nyc --reporter=lcov --branches=99 mocha --slow=5000 --timeout=60000 ./test/unit/*.js",
+    "install": "node install/check",
+    "clean": "rm -rf src/build/ .nyc_output/ coverage/ test/fixtures/output.*",
+    "test": "npm run test-lint && npm run test-unit && npm run test-licensing && npm run test-types",
+    "test-lint": "semistandard && cpplint",
+    "test-unit": "nyc --reporter=lcov --reporter=text --check-coverage --branches=100 mocha",
+    "test-licensing": "license-checker --production --summary --onlyAllow=\"Apache-2.0;BSD;ISC;LGPL-3.0-or-later;MIT\"",
     "test-leak": "./test/leak/leak.sh",
-    "test-packaging": "./packaging/test-linux-x64.sh",
-    "docs": "for m in constructor input resize composite operation colour channel output utility; do documentation build --shallow --format=md lib/$m.js >docs/api-$m.md; done"
+    "test-types": "tsd",
+    "package-from-local-build": "node npm/from-local-build",
+    "package-from-github-release": "node npm/from-github-release",
+    "docs-build": "node docs/build.mjs",
+    "docs-serve": "cd docs && npm start",
+    "docs-publish": "cd docs && npm run build && npx firebase-tools deploy --project pixelplumbing --only hosting:pixelplumbing-sharp"
   },
+  "type": "commonjs",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "install",
+    "lib",
+    "src/*.{cc,h,gyp}"
+  ],
   "repository": {
     "type": "git",
-    "url": "git://github.com/lovell/sharp"
+    "url": "git://github.com/lovell/sharp.git"
   },
   "keywords": [
     "jpeg",
     "png",
     "webp",
+    "avif",
     "tiff",
     "gif",
     "svg",
+    "jp2",
     "dzi",
     "image",
     "resize",
     "thumbnail",
     "crop",
+    "embed",
     "libvips",
     "vips"
   ],
   "dependencies": {
-    "caw": "^2.0.0",
-    "color": "^1.0.3",
-    "got": "^7.0.0",
-    "nan": "^2.6.2",
-    "semver": "^5.3.0",
-    "tar": "^3.1.3"
+    "color": "^4.2.3",
+    "detect-libc": "^2.0.4",
+    "semver": "^7.7.2"
+  },
+  "optionalDependencies": {
+    "@img/sharp-darwin-arm64": "0.34.2-rc.0",
+    "@img/sharp-darwin-x64": "0.34.2-rc.0",
+    "@img/sharp-libvips-darwin-arm64": "1.1.0",
+    "@img/sharp-libvips-darwin-x64": "1.1.0",
+    "@img/sharp-libvips-linux-arm": "1.1.0",
+    "@img/sharp-libvips-linux-arm64": "1.1.0",
+    "@img/sharp-libvips-linux-ppc64": "1.1.0",
+    "@img/sharp-libvips-linux-s390x": "1.1.0",
+    "@img/sharp-libvips-linux-x64": "1.1.0",
+    "@img/sharp-libvips-linuxmusl-arm64": "1.1.0",
+    "@img/sharp-libvips-linuxmusl-x64": "1.1.0",
+    "@img/sharp-linux-arm": "0.34.2-rc.0",
+    "@img/sharp-linux-arm64": "0.34.2-rc.0",
+    "@img/sharp-linux-s390x": "0.34.2-rc.0",
+    "@img/sharp-linux-x64": "0.34.2-rc.0",
+    "@img/sharp-linuxmusl-arm64": "0.34.2-rc.0",
+    "@img/sharp-linuxmusl-x64": "0.34.2-rc.0",
+    "@img/sharp-wasm32": "0.34.2-rc.0",
+    "@img/sharp-win32-arm64": "0.34.2-rc.0",
+    "@img/sharp-win32-ia32": "0.34.2-rc.0",
+    "@img/sharp-win32-x64": "0.34.2-rc.0"
   },
   "devDependencies": {
-    "async": "^2.4.1",
-    "cc": "^1.0.1",
-    "documentation": "^4.0.0-rc.1",
-    "exif-reader": "^1.0.2",
-    "icc": "^1.0.0",
-    "mocha": "^3.4.2",
-    "nyc": "^10.3.2",
-    "rimraf": "^2.6.1",
-    "semistandard": "^11.0.0",
-    "unzip": "^0.1.11"
+    "@emnapi/runtime": "^1.4.3",
+    "@img/sharp-libvips-dev": "1.1.0",
+    "@img/sharp-libvips-dev-wasm32": "1.1.0",
+    "@img/sharp-libvips-win32-arm64": "1.1.0",
+    "@img/sharp-libvips-win32-ia32": "1.1.0",
+    "@img/sharp-libvips-win32-x64": "1.1.0",
+    "@types/node": "*",
+    "cc": "^3.0.1",
+    "emnapi": "^1.4.3",
+    "exif-reader": "^2.0.2",
+    "extract-zip": "^2.0.1",
+    "icc": "^3.0.0",
+    "jsdoc-to-markdown": "^9.1.1",
+    "license-checker": "^25.0.1",
+    "mocha": "^11.2.2",
+    "node-addon-api": "^8.3.1",
+    "nyc": "^17.1.0",
+    "prebuild": "^13.0.1",
+    "semistandard": "^17.0.0",
+    "tar-fs": "^3.0.8",
+    "tsd": "^0.32.0"
   },
   "license": "Apache-2.0",
-  "config": {
-    "libvips": "8.5.5"
-  },
   "engines": {
-    "node": ">=4"
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
+    "libvips": ">=8.16.1"
+  },
+  "funding": {
+    "url": "https://opencollective.com/libvips"
+  },
+  "binary": {
+    "napi_versions": [
+      9
+    ]
   },
   "semistandard": {
     "env": [
@@ -101,9 +210,15 @@
   "cc": {
     "linelength": "120",
     "filter": [
-      "build/c++11",
-      "build/include",
-      "runtime/indentation_namespace"
+      "build/include"
     ]
+  },
+  "nyc": {
+    "include": [
+      "lib"
+    ]
+  },
+  "tsd": {
+    "directory": "test/types/"
   }
 }

packaging/README.md

@@ -1,57 +0,0 @@
-# Packaging scripts
-
-libvips and its dependencies are provided as pre-compiled shared libraries
-for the most common operating systems and CPU architectures.
-
-During `npm install`, these binaries are fetched as tarballs from
-[Bintray](https://dl.bintray.com/lovell/sharp/) via HTTPS
-and stored locally within `node_modules/sharp`.
-
-## Using a custom tarball
-
-A custom tarball stored on the local filesystem can be used instead.
-Place it in the following location, where `x.y.z` is the libvips version,
-`platform` is the value of `process.platform` and
-`arch` is the value of `process.arch` (plus the version number for ARM).
-
-`node_modules/sharp/packaging/libvips-x.y.z-platform-arch.tar.gz`
-
-For example, for libvips v8.3.3 on an ARMv6 Linux machine, use:
-
-`node_modules/sharp/packaging/libvips-8.3.3-linux-armv6.tar.gz`
-
-Remove any `sharp/lib` and `sharp/include` directories
-before running `npm install` again.
-
-## Creating a tarball
-
-Most people will not need to do this; proceed with caution.
-
-The `packaging` directory contains the top-level [build script](build.sh).
-
-### Linux
-
-One [build script](build/lin.sh) is used to (cross-)compile
-the same shared libraries within multiple containers.
-
-* [x64](linux-x64/Dockerfile)
-* [ARMv6](linux-armv6/Dockerfile)
-* [ARMv7-A](linux-armv7/Dockerfile)
-* [ARMv8-A](linux-armv8/Dockerfile)
-
-The QEMU user mode emulation binaries are required to build for
-the ARMv6 platform as the Debian armhf cross-compiler erroneously
-generates unsupported Thumb 2 instructions.
-
-```sh
-sudo apt-get install qemu-user-static
-```
-
-### Windows
-
-The output of libvips' [build-win64](https://github.com/jcupitt/build-win64)
-"web" target is [post-processed](build/win.sh) within a [container](win32-x64/Dockerfile).
-
-### OS X
-
-See [package-libvips-darwin](https://github.com/lovell/package-libvips-darwin).

packaging/build.sh

@@ -1,48 +0,0 @@
-#!/bin/sh
-set -e
-
-if [ $# -lt 1 ]; then
-  echo
-  echo "Usage: $0 VERSION [PLATFORM]"
-  echo "Build shared libraries for libvips and its dependencies via containers"
-  echo
-  echo "Please specify the libvips VERSION, e.g. 8.3.3"
-  echo
-  echo "Optionally build for only one PLATFORM, defaults to building for all"
-  echo "Possible values for PLATFORM are: win32-x64, linux-x64, linux-armv6,"
-  echo "linux-armv7, linux-armv8"
-  echo
-  exit 1
-fi
-VERSION_VIPS="$1"
-PLATFORM="${2:-all}"
-
-# Is docker available?
-if ! type docker >/dev/null; then
-  echo "Please install docker"
-  exit 1
-fi
-
-# Update base images
-for baseimage in debian:wheezy debian:jessie debian:stretch socialdefect/raspbian-jessie-core; do
-  docker pull $baseimage
-done
-
-# Windows (x64)
-if [ $PLATFORM = "all" ] || [ $PLATFORM = "win32-x64" ]; then
-  echo "Building win32-x64..."
-  docker build -t vips-dev-win32-x64 win32-x64
-  docker run --rm -e "VERSION_VIPS=${VERSION_VIPS}" -v $PWD:/packaging vips-dev-win32-x64 sh -c "/packaging/build/win.sh"
-fi
-
-# Linux (x64, ARMv6, ARMv7, ARMv8)
-for flavour in linux-x64 linux-armv6 linux-armv7 linux-armv8; do
-  if [ $PLATFORM = "all" ] || [ $PLATFORM = $flavour ]; then
-    echo "Building $flavour..."
-    docker build -t vips-dev-$flavour $flavour
-    docker run --rm -e "VERSION_VIPS=${VERSION_VIPS}" -v $PWD:/packaging vips-dev-$flavour sh -c "/packaging/build/lin.sh"
-  fi
-done
-
-# Display checksums
-sha256sum *.tar.gz

packaging/build/lin.sh

@@ -1,256 +0,0 @@
-#!/bin/sh
-set -e
-
-# Working directories
-DEPS=/deps
-TARGET=/target
-mkdir ${DEPS}
-mkdir ${TARGET}
-
-# Common build paths and flags
-export PKG_CONFIG_PATH="${PKG_CONFIG_PATH}:${TARGET}/lib/pkgconfig"
-export PATH="${PATH}:${TARGET}/bin"
-export CPPFLAGS="-I${TARGET}/include"
-export LDFLAGS="-L${TARGET}/lib"
-export CFLAGS="${FLAGS}"
-export CXXFLAGS="${FLAGS}"
-
-# Dependency version numbers
-VERSION_ZLIB=1.2.11
-VERSION_FFI=3.2.1
-VERSION_GLIB=2.53.1
-VERSION_XML2=2.9.4
-VERSION_GSF=1.14.41
-VERSION_EXIF=0.6.21
-VERSION_LCMS2=2.8
-VERSION_JPEG=1.5.1
-VERSION_PNG16=1.6.29
-VERSION_WEBP=0.6.0
-VERSION_TIFF=4.0.7
-VERSION_ORC=0.4.26
-VERSION_GDKPIXBUF=2.36.6
-VERSION_FREETYPE=2.8
-VERSION_EXPAT=2.2.0
-VERSION_FONTCONFIG=2.12.1
-VERSION_HARFBUZZ=1.4.6
-VERSION_PIXMAN=0.34.0
-VERSION_CAIRO=1.14.8
-VERSION_PANGO=1.40.5
-VERSION_CROCO=0.6.12
-VERSION_SVG=2.40.17
-VERSION_GIF=5.1.4
-
-# Least out-of-sync Sourceforge mirror
-SOURCEFORGE_MIRROR=netix
-
-mkdir ${DEPS}/zlib
-curl -Ls http://zlib.net/zlib-${VERSION_ZLIB}.tar.xz | tar xJC ${DEPS}/zlib --strip-components=1
-cd ${DEPS}/zlib
-./configure --prefix=${TARGET} --uname=linux
-make install
-rm ${TARGET}/lib/libz.a
-
-mkdir ${DEPS}/ffi
-curl -Ls ftp://sourceware.org/pub/libffi/libffi-${VERSION_FFI}.tar.gz | tar xzC ${DEPS}/ffi --strip-components=1
-cd ${DEPS}/ffi
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --disable-builddir
-make install-strip
-
-mkdir ${DEPS}/glib
-curl -Ls https://download.gnome.org/sources/glib/2.53/glib-${VERSION_GLIB}.tar.xz | tar xJC ${DEPS}/glib --strip-components=1
-cd ${DEPS}/glib
-echo glib_cv_stack_grows=no >>glib.cache
-echo glib_cv_uscore=no >>glib.cache
-./configure --cache-file=glib.cache --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking \
-  --with-pcre=internal --disable-libmount
-make install-strip
-
-mkdir ${DEPS}/xml2
-curl -Ls http://xmlsoft.org/sources/libxml2-${VERSION_XML2}.tar.gz | tar xzC ${DEPS}/xml2 --strip-components=1
-cd ${DEPS}/xml2
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking \
-  --without-python --without-debug --without-docbook --without-ftp --without-html --without-legacy \
-  --without-pattern --without-push --without-regexps --without-schemas --without-schematron --with-zlib=${TARGET}
-make install-strip
-
-mkdir ${DEPS}/gsf
-curl -Ls https://download.gnome.org/sources/libgsf/1.14/libgsf-${VERSION_GSF}.tar.xz | tar xJC ${DEPS}/gsf --strip-components=1
-cd ${DEPS}/gsf
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
-make install-strip
-
-mkdir ${DEPS}/exif
-curl -Ls http://${SOURCEFORGE_MIRROR}.dl.sourceforge.net/project/libexif/libexif/${VERSION_EXIF}/libexif-${VERSION_EXIF}.tar.bz2 | tar xjC ${DEPS}/exif --strip-components=1
-cd ${DEPS}/exif
-autoreconf -fiv
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
-make install-strip
-
-mkdir ${DEPS}/lcms2
-curl -Ls http://${SOURCEFORGE_MIRROR}.dl.sourceforge.net/project/lcms/lcms/${VERSION_LCMS2}/lcms2-${VERSION_LCMS2}.tar.gz | tar xzC ${DEPS}/lcms2 --strip-components=1
-cd ${DEPS}/lcms2
-# Apply patches for lcms2 vulnerabilities reported since v2.8
-VERSION_LCMS2_GIT_MASTER_SHA=$(curl -Ls https://api.github.com/repos/mm2/Little-CMS/git/refs/heads/master | jq -r '.object.sha' | head -c7)
-curl -Ls https://github.com/mm2/Little-CMS/compare/lcms2.8...master.patch | patch -p1 -t || true
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
-make install-strip
-
-mkdir ${DEPS}/jpeg
-curl -Ls https://github.com/libjpeg-turbo/libjpeg-turbo/archive/${VERSION_JPEG}.tar.gz | tar xzC ${DEPS}/jpeg --strip-components=1
-cd ${DEPS}/jpeg
-autoreconf -fiv
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --with-jpeg8 --without-turbojpeg
-make install-strip
-
-mkdir ${DEPS}/png16
-curl -Ls http://${SOURCEFORGE_MIRROR}.dl.sourceforge.net/project/libpng/libpng16/${VERSION_PNG16}/libpng-${VERSION_PNG16}.tar.xz | tar xJC ${DEPS}/png16 --strip-components=1
-cd ${DEPS}/png16
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
-make install-strip
-
-mkdir ${DEPS}/webp
-curl -Ls http://downloads.webmproject.org/releases/webp/libwebp-${VERSION_WEBP}.tar.gz | tar xzC ${DEPS}/webp --strip-components=1
-cd ${DEPS}/webp
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking \
-  --disable-neon --enable-libwebpmux
-make install-strip
-
-mkdir ${DEPS}/tiff
-curl -Ls http://download.osgeo.org/libtiff/tiff-${VERSION_TIFF}.tar.gz | tar xzC ${DEPS}/tiff --strip-components=1
-cd ${DEPS}/tiff
-# Apply patches for libtiff vulnerabilities reported since v4.0.7
-VERSION_TIFF_GIT_MASTER_SHA=$(curl -Ls https://api.github.com/repos/vadz/libtiff/git/refs/heads/master | jq -r '.object.sha' | head -c7)
-curl -Ls https://github.com/vadz/libtiff/compare/Release-v4-0-7...master.patch | patch -p1 -t || true
-if [ -n "${CHOST}" ]; then autoreconf -fiv; fi
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --disable-mdi --disable-pixarlog --disable-cxx
-make install-strip
-
-mkdir ${DEPS}/orc
-curl -Ls http://gstreamer.freedesktop.org/data/src/orc/orc-${VERSION_ORC}.tar.xz | tar xJC ${DEPS}/orc --strip-components=1
-cd ${DEPS}/orc
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
-make install-strip
-cd ${TARGET}/lib
-rm -rf liborc-test-*
-
-mkdir ${DEPS}/gdkpixbuf
-curl -Ls https://download.gnome.org/sources/gdk-pixbuf/2.36/gdk-pixbuf-${VERSION_GDKPIXBUF}.tar.xz | tar xJC ${DEPS}/gdkpixbuf --strip-components=1
-cd ${DEPS}/gdkpixbuf
-touch gdk-pixbuf/loaders.cache
-LD_LIBRARY_PATH=${TARGET}/lib \
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking \
-  --disable-introspection --disable-modules --disable-gio-sniffing \
-  --without-libtiff --without-gdiplus --with-included-loaders=png,jpeg
-make install-strip
-
-mkdir ${DEPS}/freetype
-curl -Ls http://${SOURCEFORGE_MIRROR}.dl.sourceforge.net/project/freetype/freetype2/${VERSION_FREETYPE}/freetype-${VERSION_FREETYPE}.tar.gz | tar xzC ${DEPS}/freetype --strip-components=1
-cd ${DEPS}/freetype
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static
-make install
-
-mkdir ${DEPS}/expat
-curl -Ls http://${SOURCEFORGE_MIRROR}.dl.sourceforge.net/project/expat/expat/${VERSION_EXPAT}/expat-${VERSION_EXPAT}.tar.bz2 | tar xjC ${DEPS}/expat --strip-components=1
-cd ${DEPS}/expat
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static
-make install
-
-mkdir ${DEPS}/fontconfig
-curl -Ls https://www.freedesktop.org/software/fontconfig/release/fontconfig-${VERSION_FONTCONFIG}.tar.bz2 | tar xjC ${DEPS}/fontconfig --strip-components=1
-cd ${DEPS}/fontconfig
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking \
-  --with-expat-includes=${TARGET}/include --with-expat-lib=${TARGET}/lib --sysconfdir=/etc
-make install-strip
-
-mkdir ${DEPS}/harfbuzz
-curl -Ls https://www.freedesktop.org/software/harfbuzz/release/harfbuzz-${VERSION_HARFBUZZ}.tar.bz2 | tar xjC ${DEPS}/harfbuzz --strip-components=1
-cd ${DEPS}/harfbuzz
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
-make install-strip
-
-mkdir ${DEPS}/pixman
-curl -Ls http://cairographics.org/releases/pixman-${VERSION_PIXMAN}.tar.gz | tar xzC ${DEPS}/pixman --strip-components=1
-cd ${DEPS}/pixman
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --disable-libpng --disable-arm-iwmmxt
-make install-strip
-
-mkdir ${DEPS}/cairo
-curl -Ls http://cairographics.org/releases/cairo-${VERSION_CAIRO}.tar.xz | tar xJC ${DEPS}/cairo --strip-components=1
-cd ${DEPS}/cairo
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking \
-  --disable-xlib --disable-xcb --disable-quartz --disable-win32 --disable-egl --disable-glx --disable-wgl \
-  --disable-script --disable-ps --disable-gobject --disable-trace --disable-interpreter
-make install-strip
-
-mkdir ${DEPS}/pango
-curl -Ls https://download.gnome.org/sources/pango/1.40/pango-${VERSION_PANGO}.tar.xz | tar xJC ${DEPS}/pango --strip-components=1
-cd ${DEPS}/pango
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
-make install-strip
-
-mkdir ${DEPS}/croco
-curl -Ls https://download.gnome.org/sources/libcroco/0.6/libcroco-${VERSION_CROCO}.tar.xz | tar xJC ${DEPS}/croco --strip-components=1
-cd ${DEPS}/croco
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
-make install-strip
-
-mkdir ${DEPS}/svg
-curl -Ls https://download.gnome.org/sources/librsvg/2.40/librsvg-${VERSION_SVG}.tar.xz | tar xJC ${DEPS}/svg --strip-components=1
-cd ${DEPS}/svg
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --disable-introspection --disable-tools --disable-pixbuf-loader
-make install-strip
-
-mkdir ${DEPS}/gif
-curl -Ls http://${SOURCEFORGE_MIRROR}.dl.sourceforge.net/project/giflib/giflib-${VERSION_GIF}.tar.gz | tar xzC ${DEPS}/gif --strip-components=1
-cd ${DEPS}/gif
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
-make install-strip
-
-mkdir ${DEPS}/vips
-curl -Ls https://github.com/jcupitt/libvips/releases/download/v${VERSION_VIPS}/vips-${VERSION_VIPS}.tar.gz | tar xzC ${DEPS}/vips --strip-components=1
-cd ${DEPS}/vips
-./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking \
-  --disable-debug --disable-introspection --without-python --without-fftw \
-  --without-magick --without-pangoft2 --without-ppm --without-analyze --without-radiance \
-  --with-zip-includes=${TARGET}/include --with-zip-libraries=${TARGET}/lib \
-  --with-jpeg-includes=${TARGET}/include --with-jpeg-libraries=${TARGET}/lib
-make install-strip
-
-# Remove the old C++ bindings
-cd ${TARGET}/include
-rm -rf vips/vipsc++.h vips/vipscpp.h
-cd ${TARGET}/lib
-rm -rf pkgconfig .libs *.la libvipsCC*
-
-# Create JSON file of version numbers
-cd ${TARGET}
-echo "{\n\
-  \"cairo\": \"${VERSION_CAIRO}\",\n\
-  \"croco\": \"${VERSION_CROCO}\",\n\
-  \"exif\": \"${VERSION_EXIF}\",\n\
-  \"expat\": \"${VERSION_EXPAT}\",\n\
-  \"ffi\": \"${VERSION_FFI}\",\n\
-  \"fontconfig\": \"${VERSION_FONTCONFIG}\",\n\
-  \"freetype\": \"${VERSION_FREETYPE}\",\n\
-  \"gdkpixbuf\": \"${VERSION_GDKPIXBUF}\",\n\
-  \"gif\": \"${VERSION_GIF}\",\n\
-  \"glib\": \"${VERSION_GLIB}\",\n\
-  \"gsf\": \"${VERSION_GSF}\",\n\
-  \"harfbuzz\": \"${VERSION_HARFBUZZ}\",\n\
-  \"jpeg\": \"${VERSION_JPEG}\",\n\
-  \"lcms\": \"${VERSION_LCMS2}-${VERSION_LCMS2_GIT_MASTER_SHA}\",\n\
-  \"orc\": \"${VERSION_ORC}\",\n\
-  \"pango\": \"${VERSION_PANGO}\",\n\
-  \"pixman\": \"${VERSION_PIXMAN}\",\n\
-  \"png\": \"${VERSION_PNG16}\",\n\
-  \"svg\": \"${VERSION_SVG}\",\n\
-  \"tiff\": \"${VERSION_TIFF}-${VERSION_TIFF_GIT_MASTER_SHA}\",\n\
-  \"vips\": \"${VERSION_VIPS}\",\n\
-  \"webp\": \"${VERSION_WEBP}\",\n\
-  \"xml\": \"${VERSION_XML2}\",\n\
-  \"zlib\": \"${VERSION_ZLIB}\"\n\
-}" >lib/versions.json
-
-# Create .tar.gz
-tar czf /packaging/libvips-${VERSION_VIPS}-${PLATFORM}.tar.gz include lib
-advdef --recompress --shrink-insane /packaging/libvips-${VERSION_VIPS}-${PLATFORM}.tar.gz

packaging/build/win.sh

@@ -1,19 +0,0 @@
-#!/bin/sh
-set -e
-
-# Fetch and unzip
-mkdir /vips
-cd /vips
-curl -L -O https://github.com/lovell/build-win64/releases/download/v${VERSION_VIPS}/vips-dev-w64-web-${VERSION_VIPS}.zip
-unzip vips-dev-w64-web-${VERSION_VIPS}.zip
-
-# Clean and zip
-cd /vips/vips-dev-8.5
-rm bin/libvipsCC-42.dll bin/libvips-cpp-42.dll bin/libgsf-win32-1-114.dll
-cp bin/*.dll lib/
-cp -r lib64/* lib/
-
-echo "Creating tarball"
-tar czf /packaging/libvips-${VERSION_VIPS}-${PLATFORM}.tar.gz include lib/glib-2.0 lib/libvips.lib lib/libglib-2.0.lib lib/libgobject-2.0.lib lib/*.dll
-echo "Shrinking tarball"
-advdef --recompress --shrink-insane /packaging/libvips-${VERSION_VIPS}-${PLATFORM}.tar.gz