CI: Simplify volume mappings for linuxmusl-arm64 runners

Use these as the body for (future) GitHub releases

.circleci/config.yml

@@ -1,79 +0,0 @@
-version: 2.1
-
-workflows:
-  build:
-    jobs:
-      - linux-arm64-glibc-node-12:
-          filters:
-            tags:
-              only: /^v.*/
-      - linux-arm64-musl-node-12:
-          filters:
-            tags:
-              only: /^v.*/
-      - linux-arm64-glibc-node-16:
-          filters:
-            tags:
-              only: /^v.*/
-      - linux-arm64-musl-node-16:
-          filters:
-            tags:
-              only: /^v.*/
-
-jobs:
-  linux-arm64-glibc-node-12:
-    resource_class: arm.medium
-    machine:
-      image: ubuntu-2004:202101-01
-    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"
-          sudo docker exec sharp sh -c "curl -s https://deb.nodesource.com/gpgkey/nodesource.gpg.key | apt-key add -"
-          sudo docker exec sharp sh -c "echo 'deb https://deb.nodesource.com/node_12.x sid main' >/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 --unsafe-perm"
-      - run: sudo docker exec sharp sh -c "npm test"
-      - run: "[[ -n $CIRCLE_TAG ]] && sudo docker exec --env prebuild_upload sharp sh -c \"npx prebuild --runtime napi --target 5 --upload=$prebuild_upload\" || true"
-  linux-arm64-glibc-node-16:
-    resource_class: arm.medium
-    machine:
-      image: ubuntu-2004:202101-01
-    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"
-          sudo docker exec sharp sh -c "curl -s https://deb.nodesource.com/gpgkey/nodesource.gpg.key | apt-key add -"
-          sudo docker exec sharp sh -c "echo 'deb https://deb.nodesource.com/node_16.x sid main' >/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"
-  linux-arm64-musl-node-12:
-    resource_class: arm.medium
-    machine:
-      image: ubuntu-2004:202101-01
-    steps:
-      - checkout
-      - run: |
-          sudo docker run -dit --name sharp --volume "${PWD}:/mnt/sharp" --workdir /mnt/sharp node:12-alpine3.11
-          sudo docker exec sharp sh -c "apk add build-base git python3 --update-cache"
-      - run: sudo docker exec sharp sh -c "npm install --build-from-source --unsafe-perm"
-      - run: sudo docker exec sharp sh -c "npm test"
-      - run: "[[ -n $CIRCLE_TAG ]] && sudo docker exec --env prebuild_upload sharp sh -c \"npx prebuild --runtime napi --target 5 --upload=$prebuild_upload\" || true"
-  linux-arm64-musl-node-16:
-    resource_class: arm.medium
-    machine:
-      image: ubuntu-2004:202101-01
-    steps:
-      - checkout
-      - run: |
-          sudo docker run -dit --name sharp --workdir /mnt/sharp node:16-alpine3.11
-          sudo docker exec sharp sh -c "apk add build-base git python3 --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"

.cirrus.yml

@@ -1,16 +1,17 @@
 freebsd_instance:
-  image_family: freebsd-13-0-snap
+  image_family: freebsd-15-0-snap
 
 task:
-  name: FreeBSD 13.0
+  name: FreeBSD
   env:
     IGNORE_OSVERSION: yes
   skip_notifications: true
   prerequisites_script:
     - pkg update -f
     - pkg upgrade -y
-    - pkg install -y pkgconf vips node npm
+    - 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 --unsafe-perm
+    - npm install --build-from-source
   test_script:
-    - npm test
+    - npx mocha --no-config --spec=test/unit/io.js --timeout=30000

.gitattributes

@@ -1 +0,0 @@
-src/libvips/* linguist-vendored

.github/CONTRIBUTING.md

@@ -16,29 +16,30 @@ If a [similar request](https://github.com/lovell/sharp/labels/enhancement) exist
 it's probably fastest to add a comment to it about your requirement.
 
 Implementation is usually straightforward if libvips
-[already supports](https://libvips.github.io/libvips/API/current/func-list.html)
+[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 --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.
 
@@ -62,7 +63,7 @@ By way of example, the `background()` method present in v0.20.0 was deprecated i
 
 ## 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
@@ -93,5 +94,5 @@ 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#L5)
+[e-mail](https://github.com/lovell/sharp/blob/main/package.json#L5)
 for private, paid consulting.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -5,12 +5,24 @@ labels: enhancement
 
 ---
 
-What are you trying to achieve?
+## Feature request
 
-Have you searched for similar feature requests?
+### What are you trying to achieve?
 
-What would you expect the API to look like?
+<!-- Please provide context here. -->
 
-What alternatives have you considered?
+### When you searched for similar feature requests, what did you find that might be related?
 
-Is there a sample image that helps explain?
+<!-- 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

@@ -5,18 +5,65 @@ labels: installation
 
 ---
 
-Did you see the [documentation relating to installation](https://sharp.pixelplumbing.com/install)?
+<!-- Please try to answer as many of these questions as possible. -->
 
-Have you ensured the architecture and platform of Node.js used for `npm install` is the same as the architecture and platform of Node.js used at runtime?
+## Possible install-time or require-time problem
 
-Are you using the latest version? Is the version currently in use as reported by `npm ls sharp` the same as the latest version as reported by `npm view sharp dist-tags.latest`?
+<!-- Please place an [x] in the box to confirm. -->
 
-If you are using npm v6 or earlier and installing as a `root` or `sudo` user, have you tried with the `npm install --unsafe-perm` flag?
+- [ ] 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.
 
-If you are using npm v7, does the user running `npm install` own the directory it is run in?
+You must confirm both of these before continuing.
 
-If you are using the `ignore-scripts` feature of `npm`, have you tried with the `npm install --ignore-scripts=false` flag?
+### Are you using the latest version of sharp?
 
-What is the complete output of running `npm install --verbose sharp`? Have you checked this output for useful error messages?
+<!-- Please place an [x] in the box to confirm. -->
 
-What is the output of running `npx envinfo --binaries --system`?
+- [ ] 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

@@ -7,14 +7,59 @@ labels: triage
 
 <!-- If this issue relates to installation, please use https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md instead. -->
 
-Are you using the latest version? Is the version currently in use as reported by `npm ls sharp` the same as the latest version as reported by `npm view sharp dist-tags.latest`?
+## Possible bug
 
-What are the steps to reproduce?
+### Is this a possible bug in a feature of sharp, unrelated to installation?
 
-What is the expected behaviour?
+<!-- Please place an [x] in the box to confirm. -->
 
-Are you able to provide a minimal, standalone code sample, without other dependencies, that demonstrates this problem?
+- [ ] Running `npm install sharp` completes without error.
+- [ ] Running `node -e "require('sharp')"` completes without error.
 
-Are you able to provide a sample image that helps explain the problem?
+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.
 
-What is the output of running `npx envinfo --binaries --system`?
+### 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

@@ -7,10 +7,20 @@ labels: question
 
 <!-- If this issue relates to installation, please use https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md instead. -->
 
-What are you trying to achieve?
+## Question about an existing feature
 
-Have you searched for similar questions?
+### What are you trying to achieve?
 
-Are you able to provide a minimal, standalone code sample that demonstrates this question?
+<!-- Please provide context here. -->
 
-Are you able to provide a sample image that helps explain the question?
+### 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-darwin-arm64v8.yml

@@ -1,36 +0,0 @@
-name: CI (MacStadium)
-on:
-  - push
-  - pull_request
-jobs:
-  CI:
-    runs-on: macos-m1
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - nodejs_version: 12
-            nodejs_architecture: x64
-          - nodejs_version: 16
-            nodejs_architecture: arm64
-            prebuild: true
-    defaults:
-      run:
-        shell: /usr/bin/arch -arch arm64e /bin/bash -l {0}
-    steps:
-      - name: Dependencies
-        uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.nodejs_version }}
-          architecture: ${{ matrix.nodejs_architecture }}
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Install
-        run: npm install --build-from-source --unsafe-perm
-      - name: Test
-        run: npm test
-      - name: Prebuild
-        if: matrix.prebuild && startsWith(github.ref, 'refs/tags/')
-        env:
-          prebuild_upload: ${{ secrets.GITHUB_TOKEN }}
-        run: npx prebuild --runtime napi --target 5

.github/workflows/ci.yml

@@ -1,81 +1,330 @@
-name: CI (GitHub)
+name: CI
 on:
   - push
   - pull_request
+permissions: {}
 jobs:
-  CI:
+  build-native:
+    permissions:
+      contents: read
+    name: "build-${{ matrix.platform }} [Node.js ${{ matrix.nodejs_version_major }}] ${{ matrix.package && '[package]' }}"
     runs-on: ${{ matrix.os }}
     container: ${{ matrix.container }}
     strategy:
       fail-fast: false
       matrix:
         include:
-          - os: ubuntu-20.04
-            container: centos:7
-            nodejs_version: 12
-            coverage: true
-            prebuild: true
-          - os: ubuntu-20.04
-            container: centos:7
-            nodejs_version: 14
-          - os: ubuntu-20.04
-            container: centos:7
-            nodejs_version: 16
-          - os: ubuntu-20.04
-            container: node:12-alpine3.11
-            prebuild: true
-          - os: ubuntu-20.04
-            container: node:14-alpine3.11
-          - os: ubuntu-20.04
-            container: node:14-alpine3.13
-          - os: ubuntu-20.04
-            container: node:16-alpine3.11
-          - os: macos-10.15
-            nodejs_version: 12
-            prebuild: true
-          - os: macos-10.15
-            nodejs_version: 14
-          - os: macos-10.15
-            nodejs_version: 16
-          - os: windows-2019
-            nodejs_version: 12
-            prebuild: true
-          - os: windows-2019
-            nodejs_version: 14
-          - os: windows-2019
-            nodejs_version: 16
+          - os: ubuntu-24.04
+            container: rockylinux:8
+            nodejs_arch: x64
+            nodejs_version: "^18.17.0"
+            nodejs_version_major: 18
+            platform: linux-x64
+            package: true
+          - os: ubuntu-24.04
+            container: rockylinux:8
+            nodejs_arch: x64
+            nodejs_version: "^20.3.0"
+            nodejs_version_major: 20
+            platform: linux-x64
+          - os: ubuntu-24.04
+            container: rockylinux:8
+            nodejs_arch: x64
+            nodejs_version: "^22.9.0"
+            nodejs_version_major: 22
+            platform: linux-x64
+          - os: ubuntu-24.04
+            container: node:18-alpine3.17
+            nodejs_version_major: 18
+            platform: linuxmusl-x64
+            package: true
+          - os: ubuntu-24.04
+            container: node:20-alpine3.18
+            nodejs_version_major: 20
+            platform: linuxmusl-x64
+          - os: ubuntu-24.04
+            container: node:22-alpine3.20
+            nodejs_version_major: 22
+            platform: linuxmusl-x64
+          - os: ubuntu-24.04-arm
+            container: arm64v8/rockylinux:8
+            nodejs_arch: arm64
+            nodejs_version: "^18.17.0"
+            nodejs_version_major: 18
+            platform: linux-arm64
+            package: true
+          - os: ubuntu-24.04-arm
+            container: arm64v8/rockylinux:8
+            nodejs_arch: arm64
+            nodejs_version: "^20.3.0"
+            nodejs_version_major: 20
+            platform: linux-arm64
+          - os: macos-13
+            nodejs_arch: x64
+            nodejs_version: "^18.17.0"
+            nodejs_version_major: 18
+            platform: darwin-x64
+            package: 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
+            package: 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-2022
+            nodejs_arch: x86
+            nodejs_version: "18.18.2" # pinned to avoid 18.19.0 and npm 10
+            nodejs_version_major: 18
+            platform: win32-ia32
+            package: true
+          - os: windows-2022
+            nodejs_arch: x86
+            nodejs_version: "^20.3.0"
+            nodejs_version_major: 20
+            platform: win32-ia32
+          - os: windows-2022
+            nodejs_arch: x86
+            nodejs_version: "^22.9.0"
+            nodejs_version_major: 22
+            platform: win32-ia32
+          - os: windows-2022
+            nodejs_arch: x64
+            nodejs_version: "^18.17.0"
+            nodejs_version_major: 18
+            platform: win32-x64
+            package: true
+          - os: windows-2022
+            nodejs_arch: x64
+            nodejs_version: "^20.3.0"
+            nodejs_version_major: 20
+            platform: win32-x64
+          - os: windows-2022
+            nodejs_arch: x64
+            nodejs_version: "^22.9.0"
+            nodejs_version_major: 22
+            platform: win32-x64
+          - os: windows-11-arm
+            nodejs_arch: arm64
+            nodejs_version: "^20.3.0"
+            nodejs_version_major: 20
+            platform: win32-arm64
+            package: true
+          - os: windows-11-arm
+            nodejs_arch: arm64
+            nodejs_version: "^22.9.0"
+            nodejs_version_major: 22
+            platform: win32-arm64
     steps:
-      - name: Dependencies (Linux glibc)
-        if: contains(matrix.container, 'centos')
+      - name: Dependencies (Rocky Linux glibc)
+        if: contains(matrix.container, 'rockylinux')
         run: |
-          curl -sL https://rpm.nodesource.com/setup_${{ matrix.nodejs_version }}.x | bash -
-          yum install -y centos-release-scl
-          yum install -y devtoolset-10-gcc-c++ make git python3 nodejs
-          echo "/opt/rh/devtoolset-10/root/usr/bin" >> $GITHUB_PATH
+          dnf install -y gcc-toolset-14-gcc-c++ make git python3.12 fontconfig google-noto-sans-fonts
+          echo "/opt/rh/gcc-toolset-14/root/usr/bin" >> $GITHUB_PATH
       - name: Dependencies (Linux musl)
         if: contains(matrix.container, 'alpine')
-        run: apk add build-base git python3 --update-cache
-      - name: Dependencies (macOS, Windows)
+        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-node@v1
+        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 }}
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Fix working directory ownership
-        if: matrix.container
-        run: chown root.root .
+          architecture: ${{ matrix.nodejs_arch }}
+      - uses: actions/checkout@v4
       - name: Install
-        run: npm install --build-from-source --unsafe-perm
+        run: npm install --build-from-source
       - name: Test
         run: npm test
-      - name: Coverage
-        if: matrix.coverage
-        uses: coverallsapp/github-action@v1.1.2
+      - name: Populate npm package
+        if: matrix.package
+        run: npm run package-from-local-build
+      - uses: actions/upload-artifact@v4
+        if: matrix.package
         with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-      - name: Prebuild
-        if: matrix.prebuild && startsWith(github.ref, 'refs/tags/')
-        env:
-          prebuild_upload: ${{ secrets.GITHUB_TOKEN }}
-        run: npx prebuild --runtime napi --target 5
+          name: ${{ matrix.platform }}
+          path: npm/${{ matrix.platform }}
+          retention-days: 1
+          if-no-files-found: error
+  build-linuxmusl-arm64:
+    permissions:
+      contents: read
+    name: "build-linuxmusl-arm64 [Node.js ${{ matrix.nodejs_version_major }}] ${{ matrix.package && '[package]' }}"
+    runs-on: ubuntu-24.04-arm
+    container:
+      image: ${{ matrix.container }}
+      volumes:
+        - /opt:/opt:rw,rshared
+        - /opt:/__e/node20:ro,rshared
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - container: node:18-alpine3.17
+          nodejs_version_major: 18
+          package: true
+        - container: node:20-alpine3.18
+          nodejs_version_major: 20
+    steps:
+      - name: Allow Linux musl containers on ARM64 runners # https://github.com/actions/runner/issues/801#issuecomment-2394425757
+        shell: sh
+        run: |
+          sed -i "/^ID=/s/alpine/NotpineForGHA/" /etc/os-release
+          apk add nodejs --update-cache
+          mkdir /opt/bin
+          ln -s /usr/bin/node /opt/bin/node
+      - name: Dependencies
+        run: apk add build-base git python3 font-noto --update-cache
+      - uses: actions/checkout@v4
+      - name: Install
+        run: npm install --build-from-source
+      - name: Test
+        run: npm test
+      - name: Populate npm package
+        if: matrix.package
+        run: npm run package-from-local-build
+      - uses: actions/upload-artifact@v4
+        if: matrix.package
+        with:
+          name: linuxmusl-arm64
+          path: npm/linuxmusl-arm64
+          retention-days: 1
+          if-no-files-found: error
+  build-qemu:
+    permissions:
+      contents: read
+    name: "build-${{ matrix.platform }} [Node.js ${{ matrix.nodejs_version_major }}] [package]"
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: linux-arm
+            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 }}
+          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
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.platform }}
+          path: npm/${{ matrix.platform }}
+          retention-days: 1
+          if-no-files-found: error
+  build-emscripten:
+    permissions:
+      contents: read
+    name: "build-wasm32 [package]"
+    runs-on: ubuntu-24.04
+    container: "emscripten/emsdk:4.0.10"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Dependencies
+        run: apt-get update && apt-get install -y pkg-config
+      - name: Dependencies (Node.js)
+        uses: actions/setup-node@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: Populate npm package
+        run: emmake npm run package-from-local-build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wasm32
+          path: npm/wasm32
+          retention-days: 1
+          if-no-files-found: error
+  release:
+    permissions:
+      contents: write
+    runs-on: ubuntu-24.04
+    needs:
+      - build-native
+      - build-linuxmusl-arm64
+      - build-qemu
+      - build-emscripten
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          path: npm
+      - name: Create npm workspace tarball
+        run: tar -vcaf npm-workspace.tar.xz --directory npm --exclude=from-local-build.js .
+      - name: Parse semver for tag
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: madhead/semver-utils@v4
+        id: semver
+        with:
+          version: ${{ github.ref_name }}
+      - name: Create GitHub release for tag
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: npm-workspace.tar.xz
+          artifactContentType: application/x-xz
+          prerelease: ${{ contains(github.ref, '-rc') }}
+          makeLatest: ${{ !contains(github.ref, '-rc') }}
+          bodyFile: "docs/src/content/docs/changelog/v${{ steps.semver.outputs.major }}.${{ steps.semver.outputs.minor }}.${{ steps.semver.outputs.patch }}.md"

.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-2022
+            runtime: node
+            package-manager: npm
+          - name: win32-x64-node-pnpm
+            runs-on: windows-2022
+            runtime: node
+            package-manager: pnpm
+          - name: win32-x64-node-yarn
+            runs-on: windows-2022
+            runtime: node
+            package-manager: yarn
+          - name: win32-x64-node-yarn-pnp
+            runs-on: windows-2022
+            runtime: node
+            package-manager: yarn-pnp
+          - name: win32-x64-node-yarn-v1
+            runs-on: windows-2022
+            runtime: node
+            package-manager: yarn-v1
+          - name: win32-x64-deno
+            runs-on: windows-2022
+            runtime: deno
+
+    steps:
+      - name: Install Node.js
+        if: ${{ matrix.runtime == 'node' }}
+        uses: actions/setup-node@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,18 +1,18 @@
-build
+src/build
+src/node_modules
 node_modules
 /coverage
+npm/*/*
+!npm/*/package.json
 test/bench/node_modules
 test/fixtures/output*
+test/fixtures/vips-properties.xml
 test/leak/libvips.supp
-test/saliency/report.json
-test/saliency/Image*
-test/saliency/[Uu]serData*
-!test/saliency/userData.js
-vendor
-.gitattributes
 .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"
+}

.prebuildrc

@@ -1,4 +0,0 @@
-{
-  "include-regex": "(sharp-.+\\.node|libvips-cpp\\.dll)",
-  "strip": true
-}

README.md

@@ -1,11 +1,15 @@
 # sharp
 
-<img src="https://cdn.jsdelivr.net/gh/lovell/sharp@master/docs/image/sharp-logo.svg" width="160" height="160" alt="sharp logo" align="right">
+<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, WebP, GIF and AVIF images of varying dimensions.
 
+It can be used with all JavaScript runtimes
+that provide support for Node-API v9, including
+Node.js (^18.17.0 or >= 20.3.0), Deno and Bun.
+
 Resizing an image is typically 4x-5x faster than using the
 quickest ImageMagick and GraphicsMagick settings
 due to its use of [libvips](https://github.com/libvips/libvips).
@@ -16,7 +20,7 @@ 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 running Node.js >= 12.13.0
+Most modern macOS, Windows and Linux systems
 do not require any additional install or runtime dependencies.
 
 ## Documentation
@@ -95,15 +99,12 @@ readableStream
 
 ## Contributing
 
-A [guide for contributors](https://github.com/lovell/sharp/blob/master/.github/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.
 
-[![Test Coverage](https://coveralls.io/repos/lovell/sharp/badge.svg?branch=master)](https://coveralls.io/r/lovell/sharp?branch=master)
-[![Node-API v5](https://img.shields.io/badge/Node--API-v5-green.svg)](https://nodejs.org/dist/latest/docs/api/n-api.html#n_api_n_api_version_matrix)
-
 ## Licensing
 
-Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022 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.

appveyor.yml

@@ -1,17 +0,0 @@
-os: Visual Studio 2019
-version: "{build}"
-build: off
-platform: x86
-environment:
-  matrix:
-  - nodejs_version: "12"
-    prebuild: true
-  - nodejs_version: "14"
-  - nodejs_version: "16"
-install:
-  - ps: Update-NodeJsInstallation (Get-NodeJsLatestBuild $env:nodejs_version)
-  - npm install --build-from-source
-test_script:
-  - npm test
-on_success:
-  - if [%prebuild%] == [true] if [%APPVEYOR_REPO_TAG%] == [true] npx prebuild --runtime napi --target 5

binding.gyp

@@ -1,235 +0,0 @@
-{
-  'variables': {
-    'vips_version': '<!(node -p "require(\'./lib/libvips\').minimumLibvipsVersion")',
-    'platform_and_arch': '<!(node -p "require(\'./lib/platform\')()")',
-    'sharp_vendor_dir': './vendor/<(vips_version)/<(platform_and_arch)'
-  },
-  'targets': [{
-    'target_name': 'libvips-cpp',
-    'conditions': [
-      ['OS == "win"', {
-        # Build libvips C++ binding for Windows due to MSVC std library ABI changes
-        'type': 'shared_library',
-        'defines': [
-          'VIPS_CPLUSPLUS_EXPORTS',
-          '_ALLOW_KEYWORD_MACROS'
-        ],
-        'sources': [
-          'src/libvips/cplusplus/VError.cpp',
-          'src/libvips/cplusplus/VConnection.cpp',
-          'src/libvips/cplusplus/VInterpolate.cpp',
-          'src/libvips/cplusplus/VImage.cpp'
-        ],
-        'include_dirs': [
-          '<(sharp_vendor_dir)/include',
-          '<(sharp_vendor_dir)/include/glib-2.0',
-          '<(sharp_vendor_dir)/lib/glib-2.0/include'
-        ],
-        'link_settings': {
-          'library_dirs': ['<(sharp_vendor_dir)/lib'],
-          'libraries': [
-            'libvips.lib',
-            'libglib-2.0.lib',
-            'libgobject-2.0.lib'
-          ],
-        },
-        'configurations': {
-          'Release': {
-            'msvs_settings': {
-              'VCCLCompilerTool': {
-                'ExceptionHandling': 1,
-                'Optimization': 1,
-                'RuntimeLibrary': '2', # /MD
-                'WholeProgramOptimization': 'true'
-              },
-              'VCLibrarianTool': {
-                'AdditionalOptions': [
-                  '/LTCG:INCREMENTAL'
-                ]
-              },
-              'VCLinkerTool': {
-                'ImageHasSafeExceptionHandlers': 'false',
-                'OptimizeReferences': 2,
-                'EnableCOMDATFolding': 2,
-                'LinkIncremental': 1,
-                'AdditionalOptions': [
-                  '/LTCG:INCREMENTAL'
-                ]
-              }
-            },
-            'msvs_disabled_warnings': [
-              4275
-            ]
-          }
-        }
-      }, {
-        # Ignore this target for non-Windows
-        'type': 'none'
-      }]
-    ]
-  }, {
-    'target_name': 'sharp-<(platform_and_arch)',
-    'defines': [
-      'NAPI_VERSION=5'
-    ],
-    'dependencies': [
-      '<!(node -p "require(\'node-addon-api\').gyp")',
-      'libvips-cpp'
-    ],
-    'variables': {
-      'runtime_link%': 'shared',
-      'conditions': [
-        ['OS != "win"', {
-          'pkg_config_path': '<!(node -p "require(\'./lib/libvips\').pkgConfigPath()")',
-          'use_global_libvips': '<!(node -p "Boolean(require(\'./lib/libvips\').useGlobalLibvips()).toString()")'
-        }, {
-          'pkg_config_path': '',
-          'use_global_libvips': ''
-        }]
-      ]
-    },
-    'sources': [
-      'src/common.cc',
-      'src/metadata.cc',
-      'src/stats.cc',
-      'src/operations.cc',
-      'src/pipeline.cc',
-      'src/utilities.cc',
-      'src/sharp.cc'
-    ],
-    'include_dirs': [
-      '<!(node -p "require(\'node-addon-api\').include_dir")',
-    ],
-    'conditions': [
-      ['use_global_libvips == "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)'
-            ]
-          }]
-        ]
-      }, {
-        # Use pre-built libvips stored locally within node_modules
-        'include_dirs': [
-          '<(sharp_vendor_dir)/include',
-          '<(sharp_vendor_dir)/include/glib-2.0',
-          '<(sharp_vendor_dir)/lib/glib-2.0/include'
-        ],
-        'conditions': [
-          ['OS == "win"', {
-            'defines': [
-              '_ALLOW_KEYWORD_MACROS',
-              '_FILE_OFFSET_BITS=64'
-            ],
-            'link_settings': {
-              'library_dirs': ['<(sharp_vendor_dir)/lib'],
-              'libraries': [
-                'libvips.lib',
-                'libglib-2.0.lib',
-                'libgobject-2.0.lib'
-              ]
-            }
-          }],
-          ['OS == "mac"', {
-            'link_settings': {
-              'library_dirs': ['../<(sharp_vendor_dir)/lib'],
-              'libraries': [
-                'libvips-cpp.42.dylib'
-              ]
-            },
-            'xcode_settings': {
-              'OTHER_LDFLAGS': [
-                # Ensure runtime linking is relative to sharp.node
-                '-Wl,-rpath,\'@loader_path/../../<(sharp_vendor_dir)/lib\''
-              ]
-            }
-          }],
-          ['OS == "linux"', {
-            'defines': [
-              '_GLIBCXX_USE_CXX11_ABI=1'
-            ],
-            'link_settings': {
-              'library_dirs': ['../<(sharp_vendor_dir)/lib'],
-              'libraries': [
-                '-l:libvips-cpp.so.42'
-              ],
-              'ldflags': [
-                # Ensure runtime linking is relative to sharp.node
-                '-Wl,-s -Wl,--disable-new-dtags -Wl,-rpath=\'$$ORIGIN/../../<(sharp_vendor_dir)/lib\''
-              ]
-            }
-          }]
-        ]
-      }]
-    ],
-    'cflags_cc': [
-      '-std=c++0x',
-      '-fexceptions',
-      '-Wall',
-      '-Os'
-    ],
-    'xcode_settings': {
-      'CLANG_CXX_LANGUAGE_STANDARD': 'c++11',
-      'MACOSX_DEPLOYMENT_TARGET': '10.9',
-      'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
-      'GCC_ENABLE_CPP_RTTI': 'YES',
-      'OTHER_CPLUSPLUSFLAGS': [
-        '-fexceptions',
-        '-Wall',
-        '-Oz'
-      ]
-    },
-    'configurations': {
-      'Release': {
-        'conditions': [
-          ['OS == "linux"', {
-            'cflags_cc': [
-              '-Wno-cast-function-type'
-            ]
-          }],
-          ['target_arch == "arm"', {
-            'cflags_cc': [
-              '-Wno-psabi'
-            ]
-          }],
-          ['OS == "win"', {
-            'msvs_settings': {
-              'VCCLCompilerTool': {
-                'ExceptionHandling': 1,
-                'Optimization': 1,
-                'RuntimeLibrary': '2', # /MD
-                'WholeProgramOptimization': 'true'
-              },
-              'VCLibrarianTool': {
-                'AdditionalOptions': [
-                  '/LTCG:INCREMENTAL'
-                ]
-              },
-              'VCLinkerTool': {
-                'ImageHasSafeExceptionHandlers': 'false',
-                'OptimizeReferences': 2,
-                'EnableCOMDATFolding': 2,
-                'LinkIncremental': 1,
-                'AdditionalOptions': [
-                  '/LTCG:INCREMENTAL'
-                ]
-              }
-            },
-            'msvs_disabled_warnings': [
-              4275
-            ]
-          }]
-        ]
-      }
-    },
-  }]
-}

docs/api-colour.md

@@ -1,138 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## tint
-
-Tint the image using the provided chroma while preserving the image luminance.
-An alpha channel may be present and will be unchanged by the operation.
-
-### Parameters
-
-*   `rgb` **([string][1] | [Object][2])** parsed by the [color][3] module to extract chroma values.
-
-<!---->
-
-*   Throws **[Error][4]** 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][5]**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## grayscale
-
-Alternative spelling of `greyscale`.
-
-### Parameters
-
-*   `grayscale` **[Boolean][5]**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## pipelineColourspace
-
-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][6].
-
-This feature is experimental and has not yet been fully-tested with all operations.
-
-### Parameters
-
-*   `colourspace` **[string][1]?** pipeline colourspace e.g. `rgb16`, `scrgb`, `lab`, `grey16` [...][7]
-
-### Examples
-
-```javascript
-// 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')
-```
-
-*   Throws **[Error][4]** Invalid parameters
-
-Returns **Sharp** 
-
-**Meta**
-
-*   **since**: 0.29.0
-
-## pipelineColorspace
-
-Alternative spelling of `pipelineColourspace`.
-
-### Parameters
-
-*   `colorspace` **[string][1]?** pipeline colorspace.
-
-<!---->
-
-*   Throws **[Error][4]** Invalid parameters
-
-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][1]?** output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...][8]
-
-### Examples
-
-```javascript
-// Output 16 bits per pixel RGB
-await sharp(input)
- .toColourspace('rgb16')
- .toFile('16-bpp.png')
-```
-
-*   Throws **[Error][4]** Invalid parameters
-
-Returns **Sharp** 
-
-## toColorspace
-
-Alternative spelling of `toColourspace`.
-
-### Parameters
-
-*   `colorspace` **[string][1]?** output colorspace.
-
-<!---->
-
-*   Throws **[Error][4]** Invalid parameters
-
-Returns **Sharp** 
-
-[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-
-[3]: https://www.npmjs.org/package/color
-
-[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
-
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[6]: #tocolourspace
-
-[7]: https://github.com/libvips/libvips/blob/41cff4e9d0838498487a00623462204eb10ee5b8/libvips/iofuncs/enumtypes.c#L774
-
-[8]: https://github.com/libvips/libvips/blob/3c0bfdf74ce1dc37a6429bed47fa76f16e2cd70a/libvips/iofuncs/enumtypes.c#L777-L794

docs/api-composite.md

@@ -1,94 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## composite
-
-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`.
-
-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://libvips.github.io/libvips/API/current/libvips-conversion.html#VipsBlendMode][1]
-and [https://www.cairographics.org/operators/][2]
-
-### Parameters
-
-*   `images` **[Array][3]<[Object][4]>** Ordered list of images to composite
-
-    *   `images[].input` **([Buffer][5] | [String][6])?** Buffer containing image data, String containing the path to an image file, or Create object (see below)
-
-        *   `images[].input.create` **[Object][4]?** describes a blank overlay to be created.
-
-            *   `images[].input.create.width` **[Number][7]?** 
-            *   `images[].input.create.height` **[Number][7]?** 
-            *   `images[].input.create.channels` **[Number][7]?** 3-4
-            *   `images[].input.create.background` **([String][6] | [Object][4])?** parsed by the [color][8] module to extract values for red, green, blue and alpha.
-    *   `images[].blend` **[String][6]** how to blend this image with the image below. (optional, default `'over'`)
-    *   `images[].gravity` **[String][6]** gravity at which to place the overlay. (optional, default `'centre'`)
-    *   `images[].top` **[Number][7]?** the pixel offset from the top edge.
-    *   `images[].left` **[Number][7]?** the pixel offset from the left edge.
-    *   `images[].tile` **[Boolean][9]** set to true to repeat the overlay image across the entire image with the given `gravity`. (optional, default `false`)
-    *   `images[].premultiplied` **[Boolean][9]** set to true to avoid premultipling the image below. Equivalent to the `--premultiplied` vips option. (optional, default `false`)
-    *   `images[].density` **[Number][7]** number representing the DPI for vector overlay image. (optional, default `72`)
-    *   `images[].raw` **[Object][4]?** describes overlay when using raw pixel data.
-
-        *   `images[].raw.width` **[Number][7]?** 
-        *   `images[].raw.height` **[Number][7]?** 
-        *   `images[].raw.channels` **[Number][7]?** 
-    *   `images[].failOnError` **[boolean][9]** @see [constructor parameters][10] (optional, default `true`)
-    *   `images[].limitInputPixels` **([number][7] | [boolean][9])** @see [constructor parameters][10] (optional, default `268402689`)
-
-### Examples
-
-```javascript
-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!
-  });
-```
-
-*   Throws **[Error][11]** Invalid parameters
-
-Returns **Sharp** 
-
-**Meta**
-
-*   **since**: 0.22.0
-
-[1]: https://libvips.github.io/libvips/API/current/libvips-conversion.html#VipsBlendMode
-
-[2]: https://www.cairographics.org/operators/
-
-[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
-
-[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-
-[5]: https://nodejs.org/api/buffer.html
-
-[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
-
-[8]: https://www.npmjs.org/package/color
-
-[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[10]: /api-constructor#parameters
-
-[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error

docs/api-constructor.md

@@ -1,237 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## Sharp
-
-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][1] class.
-
-### Parameters
-
-*   `input` **([Buffer][2] | [Uint8Array][3] | [Uint8ClampedArray][4] | [Int8Array][5] | [Uint16Array][6] | [Int16Array][7] | [Uint32Array][8] | [Int32Array][9] | [Float32Array][10] | [Float64Array][11] | [string][12])?** if present, can be
-    a Buffer / 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.
-    JPEG, PNG, WebP, AVIF, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when not present.
-*   `options` **[Object][13]?** if present, is an Object with optional attributes.
-
-    *   `options.failOnError` **[boolean][14]** by default halt processing and raise an error when loading invalid images.
-        Set this flag to `false` if you'd rather apply a "best effort" to decode images, even if the data is corrupt or invalid. (optional, default `true`)
-    *   `options.limitInputPixels` **([number][15] | [boolean][14])** 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). (optional, default `268402689`)
-    *   `options.unlimited` **[boolean][14]** Set this to `true` to remove safety features that help prevent memory exhaustion (SVG, PNG). (optional, default `false`)
-    *   `options.sequentialRead` **[boolean][14]** Set this to `true` to use sequential rather than random access where possible.
-        This can reduce memory usage and might improve performance on some systems. (optional, default `false`)
-    *   `options.density` **[number][15]** number representing the DPI for vector images in the range 1 to 100000. (optional, default `72`)
-    *   `options.pages` **[number][15]** number of pages to extract for multi-page input (GIF, WebP, AVIF, TIFF, PDF), use -1 for all pages. (optional, default `1`)
-    *   `options.page` **[number][15]** page number to start extracting from for multi-page input (GIF, WebP, AVIF, TIFF, PDF), zero based. (optional, default `0`)
-    *   `options.subifd` **[number][15]** subIFD (Sub Image File Directory) to extract for OME-TIFF, defaults to main image. (optional, default `-1`)
-    *   `options.level` **[number][15]** level to extract from a multi-level input (OpenSlide), zero based. (optional, default `0`)
-    *   `options.animated` **[boolean][14]** Set to `true` to read all frames/pages of an animated image (equivalent of setting `pages` to `-1`). (optional, default `false`)
-    *   `options.raw` **[Object][13]?** describes raw pixel input image data. See `raw()` for pixel ordering.
-
-        *   `options.raw.width` **[number][15]?** integral number of pixels wide.
-        *   `options.raw.height` **[number][15]?** integral number of pixels high.
-        *   `options.raw.channels` **[number][15]?** integral number of channels, between 1 and 4.
-        *   `options.raw.premultiplied` **[boolean][14]?** specifies that the raw input has already been premultiplied, set to `true`
-            to avoid sharp premultiplying the image. (optional, default `false`)
-    *   `options.create` **[Object][13]?** describes a new image to be created.
-
-        *   `options.create.width` **[number][15]?** integral number of pixels wide.
-        *   `options.create.height` **[number][15]?** integral number of pixels high.
-        *   `options.create.channels` **[number][15]?** integral number of channels, either 3 (RGB) or 4 (RGBA).
-        *   `options.create.background` **([string][12] | [Object][13])?** parsed by the [color][16] module to extract values for red, green, blue and alpha.
-        *   `options.create.noise` **[Object][13]?** describes a noise to be created.
-
-            *   `options.create.noise.type` **[string][12]?** type of generated noise, currently only `gaussian` is supported.
-            *   `options.create.noise.mean` **[number][15]?** mean of pixels in generated noise.
-            *   `options.create.noise.sigma` **[number][15]?** standard deviation of pixels in generated noise.
-
-### 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: 0.5 }
-  }
-})
-.png()
-.toBuffer()
-.then( ... );
-```
-
-```javascript
-// Convert an animated GIF to an animated WebP
-await sharp('in.gif', { animated: true }).toFile('out.webp');
-```
-
-```javascript
-// 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');
-```
-
-```javascript
-// Generate RGB Gaussian noise
-await sharp({
-  create: {
-    width: 300,
-    height: 200,
-    channels: 3,
-    noise: {
-      type: 'gaussian',
-      mean: 128,
-      sigma: 30
-    }
- }
-}).toFile('noise.png');
-```
-
-*   Throws **[Error][17]** Invalid parameters
-
-Returns **[Sharp][18]** 
-
-## 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
-```
-
-```javascript
-// 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({
-  failOnError: false
-});
-
-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#gotstreamurl-options
-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][18]** 
-
-[1]: http://nodejs.org/api/stream.html#stream_class_stream_duplex
-
-[2]: https://nodejs.org/api/buffer.html
-
-[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
-
-[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray
-
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Int8Array
-
-[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array
-
-[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Int16Array
-
-[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array
-
-[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Int32Array
-
-[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Float32Array
-
-[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Float64Array
-
-[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-
-[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[15]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
-
-[16]: https://www.npmjs.org/package/color
-
-[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
-
-[18]: #sharp

docs/api-input.md

@@ -1,132 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## metadata
-
-Fast access to (uncached) image metadata without decoding any compressed pixel data.
-
-This is taken from the header of the input image.
-It does not include operations, such as resize, to be applied to the output image.
-
-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)
-*   `height`: Number of pixels high (EXIF orientation is not taken into consideration)
-*   `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...][1]
-*   `channels`: Number of bands e.g. `3` for sRGB, `4` for CMYK
-*   `depth`: Name of pixel depth format e.g. `uchar`, `char`, `ushort`, `float` [...][2]
-*   `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
-*   `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, either an RGB Object or a single greyscale value
-*   `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][3] 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
-
-### Parameters
-
-*   `callback` **[Function][4]?** called with the arguments `(err, metadata)`
-
-### Examples
-
-```javascript
-const metadata = await sharp(input).metadata();
-```
-
-```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][5]<[Object][6]> | Sharp)** 
-
-## stats
-
-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 (experimental)
-*   `sharpness`: Estimation of greyscale sharpness based on the standard deviation of a Laplacian convolution, discarding alpha channel if any (experimental)
-*   `dominant`: Object containing most dominant sRGB colour based on a 4096-bin 3D histogram (experimental)
-
-**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).
-
-### Parameters
-
-*   `callback` **[Function][4]?** called with the arguments `(err, stats)`
-
-### Examples
-
-```javascript
-const image = sharp(inputJpg);
-image
-  .stats()
-  .then(function(stats) {
-     // stats contains the channel-wise statistics array and the isOpaque value
-  });
-```
-
-```javascript
-const { entropy, sharpness, dominant } = await sharp(input).stats();
-const { r, g, b } = dominant;
-```
-
-```javascript
-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();
-```
-
-Returns **[Promise][5]<[Object][6]>** 
-
-[1]: https://libvips.github.io/libvips/API/current/VipsImage.html#VipsInterpretation
-
-[2]: https://libvips.github.io/libvips/API/current/VipsImage.html#VipsBandFormat
-
-[3]: https://www.npmjs.com/package/icc
-
-[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
-
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
-
-[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

docs/api-operation.md

@@ -1,481 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## 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 positive degree rotation.
-For example, `-450` will produce a 270deg rotation.
-
-When rotating by an angle other than a multiple of 90,
-the background colour can be provided with the `background` option.
-
-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][1]** angle of rotation. (optional, default `auto`)
-*   `options` **[Object][2]?** if present, is an Object with optional attributes.
-
-    *   `options.background` **([string][3] | [Object][2])** parsed by the [color][4] module to extract values for red, green, blue and alpha. (optional, default `"#000000"`)
-
-### 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][5]** 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][6]**  (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][6]**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## affine
-
-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 color with the `background` option.
-A particular interpolator may also be specified. Set the `interpolator` option to an attribute of the `sharp.interpolator` Object e.g. `sharp.interpolator.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.
-
-### Parameters
-
-*   `matrix` **([Array][7]<[Array][7]<[number][1]>> | [Array][7]<[number][1]>)** affine transformation matrix
-*   `options` **[Object][2]?** if present, is an Object with optional attributes.
-
-    *   `options.background` **([String][3] | [Object][2])** parsed by the [color][4] module to extract values for red, green, blue and alpha. (optional, default `"#000000"`)
-    *   `options.idx` **[Number][1]** input horizontal offset (optional, default `0`)
-    *   `options.idy` **[Number][1]** input vertical offset (optional, default `0`)
-    *   `options.odx` **[Number][1]** output horizontal offset (optional, default `0`)
-    *   `options.ody` **[Number][1]** output vertical offset (optional, default `0`)
-    *   `options.interpolator` **[String][3]** interpolator (optional, default `sharp.interpolators.bicubic`)
-
-### Examples
-
-```javascript
-const pipeline = sharp()
-  .affine([[1, 0.3], [0.1, 0.7]], {
-     background: 'white',
-     interpolate: sharp.interpolators.nohalo
-  })
-  .toBuffer((err, outputBuffer, info) => {
-     // outputBuffer contains the transformed image
-     // info.width and info.height contain the new dimensions
-  });
-
-inputStream
-  .pipe(pipeline);
-```
-
-*   Throws **[Error][5]** Invalid parameters
-
-Returns **Sharp** 
-
-**Meta**
-
-*   **since**: 0.27.0
-
-## 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][1]?** the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
-*   `flat` **[number][1]** the level of sharpening to apply to "flat" areas. (optional, default `1.0`)
-*   `jagged` **[number][1]** the level of sharpening to apply to "jagged" areas. (optional, default `2.0`)
-
-<!---->
-
-*   Throws **[Error][5]** Invalid parameters
-
-Returns **Sharp** 
-
-## median
-
-Apply median filter.
-When used without parameters the default window is 3x3.
-
-### Parameters
-
-*   `size` **[number][1]** square mask size: size x size (optional, default `3`)
-
-<!---->
-
-*   Throws **[Error][5]** Invalid parameters
-
-Returns **Sharp** 
-
-## blur
-
-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.
-
-### Parameters
-
-*   `sigma` **[number][1]?** a value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
-
-### Examples
-
-```javascript
-const boxBlurred = await sharp(input)
-  .blur()
-  .toBuffer();
-```
-
-```javascript
-const gaussianBlurred = await sharp(input)
-  .blur(5)
-  .toBuffer();
-```
-
-*   Throws **[Error][5]** Invalid parameters
-
-Returns **Sharp** 
-
-## flatten
-
-Merge alpha transparency channel, if any, with a background, then remove the alpha channel.
-
-See also [removeAlpha][8].
-
-### Parameters
-
-*   `options` **[Object][2]?** 
-
-    *   `options.background` **([string][3] | [Object][2])** background colour, parsed by the [color][4] module, defaults to black. (optional, default `{r:0,g:0,b:0}`)
-
-### Examples
-
-```javascript
-await sharp(rgbaInput)
-  .flatten({ background: '#F0A703' })
-  .toBuffer();
-```
-
-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.
-
-Supply a second argument to use a different output gamma value, otherwise the first value is used in both cases.
-
-### Parameters
-
-*   `gamma` **[number][1]** value between 1.0 and 3.0. (optional, default `2.2`)
-*   `gammaOut` **[number][1]?** value between 1.0 and 3.0. (optional, defaults to same as `gamma`)
-
-<!---->
-
-*   Throws **[Error][5]** Invalid parameters
-
-Returns **Sharp** 
-
-## negate
-
-Produce the "negative" of the image.
-
-### Parameters
-
-*   `options` **[Object][2]?** 
-
-    *   `options.alpha` **[Boolean][6]** Whether or not to negate any alpha channel (optional, default `true`)
-
-Returns **Sharp** 
-
-## normalise
-
-Enhance output image contrast by stretching its luminance to cover the full dynamic range.
-
-### Parameters
-
-*   `normalise` **[Boolean][6]**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## normalize
-
-Alternative spelling of normalise.
-
-### Parameters
-
-*   `normalize` **[Boolean][6]**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## clahe
-
-Perform contrast limiting adaptive histogram equalization
-[CLAHE][9].
-
-This will, in general, enhance the clarity of the image by bringing out darker details.
-
-### Parameters
-
-*   `options` **[Object][2]** 
-
-    *   `options.width` **[number][1]** integer width of the region in pixels.
-    *   `options.height` **[number][1]** integer height of the region in pixels.
-    *   `options.maxSlope` **[number][1]** maximum value for the slope of the
-        cumulative histogram. A value of 0 disables contrast limiting. Valid values
-        are integers in the range 0-100 (inclusive) (optional, default `3`)
-
-<!---->
-
-*   Throws **[Error][5]** Invalid parameters
-
-Returns **Sharp** 
-
-**Meta**
-
-*   **since**: 0.28.3
-
-## convolve
-
-Convolve the image with the specified kernel.
-
-### Parameters
-
-*   `kernel` **[Object][2]** 
-
-    *   `kernel.width` **[number][1]** width of the kernel in pixels.
-    *   `kernel.height` **[number][1]** height of the kernel in pixels.
-    *   `kernel.kernel` **[Array][7]<[number][1]>** Array of length `width*height` containing the kernel values.
-    *   `kernel.scale` **[number][1]** the scale of the kernel in pixels. (optional, default `sum`)
-    *   `kernel.offset` **[number][1]** 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][5]** Invalid parameters
-
-Returns **Sharp** 
-
-## threshold
-
-Any pixel value greater than or equal to the threshold value will be set to 255, otherwise it will be set to 0.
-
-### Parameters
-
-*   `threshold` **[number][1]** a value in the range 0-255 representing the level at which the threshold will be applied. (optional, default `128`)
-*   `options` **[Object][2]?** 
-
-    *   `options.greyscale` **[Boolean][6]** convert to single channel greyscale. (optional, default `true`)
-    *   `options.grayscale` **[Boolean][6]** alternative spelling for greyscale. (optional, default `true`)
-
-<!---->
-
-*   Throws **[Error][5]** 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][10] | [string][3])** Buffer containing image data or string containing the path to an image file.
-*   `operator` **[string][3]** one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
-*   `options` **[Object][2]?** 
-
-    *   `options.raw` **[Object][2]?** describes operand when using raw pixel data.
-
-        *   `options.raw.width` **[number][1]?** 
-        *   `options.raw.height` **[number][1]?** 
-        *   `options.raw.channels` **[number][1]?** 
-
-<!---->
-
-*   Throws **[Error][5]** Invalid parameters
-
-Returns **Sharp** 
-
-## linear
-
-Apply the linear formula a \* input + b to the image (levels adjustment)
-
-### Parameters
-
-*   `a` **[number][1]** multiplier (optional, default `1.0`)
-*   `b` **[number][1]** offset (optional, default `0.0`)
-
-<!---->
-
-*   Throws **[Error][5]** Invalid parameters
-
-Returns **Sharp** 
-
-## recomb
-
-Recomb the image with the specified matrix.
-
-### Parameters
-
-*   `inputMatrix` **[Array][7]<[Array][7]<[number][1]>>** 3x3 Recombination matrix
-
-### Examples
-
-```javascript
-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 recomb
-    // With this example input, a sepia filter has been applied
-  });
-```
-
-*   Throws **[Error][5]** Invalid parameters
-
-Returns **Sharp** 
-
-**Meta**
-
-*   **since**: 0.21.1
-
-## modulate
-
-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.
-
-### Parameters
-
-*   `options` **[Object][2]?** 
-
-    *   `options.brightness` **[number][1]?** Brightness multiplier
-    *   `options.saturation` **[number][1]?** Saturation multiplier
-    *   `options.hue` **[number][1]?** Degrees for hue rotation
-    *   `options.lightness` **[number][1]?** Lightness addend
-
-### Examples
-
-```javascript
-sharp(input)
-  .modulate({
-    brightness: 2 // increase brightness by a factor of 2
-  });
-
-sharp(input)
-  .modulate({
-    hue: 180 // hue-rotate by 180 degrees
-  });
-
-sharp(input)
-  .modulate({
-    lightness: 50 // increase lightness by +50
-  });
-
-// decreate brightness and saturation while also hue-rotating by 90 degrees
-sharp(input)
-  .modulate({
-    brightness: 0.5,
-    saturation: 0.5,
-    hue: 90
-  });
-```
-
-Returns **Sharp** 
-
-**Meta**
-
-*   **since**: 0.22.1
-
-[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
-
-[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-
-[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[4]: https://www.npmjs.org/package/color
-
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
-
-[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
-
-[8]: /api-channel#removealpha
-
-[9]: https://en.wikipedia.org/wiki/Adaptive_histogram_equalization#Contrast_Limited_AHE
-
-[10]: https://nodejs.org/api/buffer.html

docs/api-output.md

@@ -1,615 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## 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, 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][1] for control over this.
-
-The caller is responsible for ensuring directory structures and permissions exist.
-
-A `Promise` is returned when `callback` is not provided.
-
-### Parameters
-
-*   `fileOut` **[string][2]** the path to write the image data to.
-*   `callback` **[Function][3]?** 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`.
-
-### Examples
-
-```javascript
-sharp(input)
-  .toFile('output.png', (err, info) => { ... });
-```
-
-```javascript
-sharp(input)
-  .toFile('output.png')
-  .then(info => { ... })
-  .catch(err => { ... });
-```
-
-*   Throws **[Error][4]** Invalid parameters
-
-Returns **[Promise][5]<[Object][6]>** when no callback is provided
-
-## toBuffer
-
-Write output to a Buffer.
-JPEG, PNG, WebP, AVIF, TIFF, GIF and raw pixel data output are supported.
-
-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][1] 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`.
-
-A `Promise` is returned when `callback` is not provided.
-
-### Parameters
-
-*   `options` **[Object][6]?** 
-
-    *   `options.resolveWithObject` **[boolean][7]?** Resolve the Promise with an Object containing `data` and `info` properties instead of resolving only with `data`.
-*   `callback` **[Function][3]?** 
-
-### Examples
-
-```javascript
-sharp(input)
-  .toBuffer((err, data, info) => { ... });
-```
-
-```javascript
-sharp(input)
-  .toBuffer()
-  .then(data => { ... })
-  .catch(err => { ... });
-```
-
-```javascript
-sharp(input)
-  .toBuffer({ resolveWithObject: true })
-  .then(({ data, info }) => { ... })
-  .catch(err => { ... });
-```
-
-```javascript
-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');
-```
-
-Returns **[Promise][5]<[Buffer][8]>** when no callback is provided
-
-## withMetadata
-
-Include all 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 unless a custom
-output profile is provided.
-
-The default behaviour, when `withMetadata` is not used, is to convert to the device-independent
-sRGB colour space and strip all metadata, including the removal of any ICC profile.
-
-### Parameters
-
-*   `options` **[Object][6]?** 
-
-    *   `options.orientation` **[number][9]?** value between 1 and 8, used to update the EXIF `Orientation` tag.
-    *   `options.icc` **[string][2]?** filesystem path to output ICC profile, defaults to sRGB.
-    *   `options.exif` **[Object][6]<[Object][6]>** Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data. (optional, default `{}`)
-    *   `options.density` **[number][9]?** Number of pixels per inch (DPI).
-
-### Examples
-
-```javascript
-sharp('input.jpg')
-  .withMetadata()
-  .toFile('output-with-metadata.jpg')
-  .then(info => { ... });
-```
-
-```javascript
-// Set "IFD0-Copyright" in output EXIF metadata
-const data = await sharp(input)
-  .withMetadata({
-    exif: {
-      IFD0: {
-        Copyright: 'Wernham Hogg'
-      }
-    }
-  })
-  .toBuffer();
-```
-
-```javascript
-// Set output metadata to 96 DPI
-const data = await sharp(input)
-  .withMetadata({ density: 96 })
-  .toBuffer();
-```
-
-*   Throws **[Error][4]** Invalid parameters
-
-Returns **Sharp** 
-
-## toFormat
-
-Force output to a given format.
-
-### Parameters
-
-*   `format` **([string][2] | [Object][6])** as a string or an Object with an 'id' attribute
-*   `options` **[Object][6]** output options
-
-### Examples
-
-```javascript
-// Convert any input to PNG output
-const data = await sharp(input)
-  .toFormat('png')
-  .toBuffer();
-```
-
-*   Throws **[Error][4]** unsupported format or options
-
-Returns **Sharp** 
-
-## jpeg
-
-Use these JPEG options for output image.
-
-### Parameters
-
-*   `options` **[Object][6]?** output options
-
-    *   `options.quality` **[number][9]** quality, integer 1-100 (optional, default `80`)
-    *   `options.progressive` **[boolean][7]** use progressive (interlace) scan (optional, default `false`)
-    *   `options.chromaSubsampling` **[string][2]** set to '4:4:4' to prevent chroma subsampling otherwise defaults to '4:2:0' chroma subsampling (optional, default `'4:2:0'`)
-    *   `options.optimiseCoding` **[boolean][7]** optimise Huffman coding tables (optional, default `true`)
-    *   `options.optimizeCoding` **[boolean][7]** alternative spelling of optimiseCoding (optional, default `true`)
-    *   `options.mozjpeg` **[boolean][7]** use mozjpeg defaults, equivalent to `{ trellisQuantisation: true, overshootDeringing: true, optimiseScans: true, quantisationTable: 3 }` (optional, default `false`)
-    *   `options.trellisQuantisation` **[boolean][7]** apply trellis quantisation (optional, default `false`)
-    *   `options.overshootDeringing` **[boolean][7]** apply overshoot deringing (optional, default `false`)
-    *   `options.optimiseScans` **[boolean][7]** optimise progressive scans, forces progressive (optional, default `false`)
-    *   `options.optimizeScans` **[boolean][7]** alternative spelling of optimiseScans (optional, default `false`)
-    *   `options.quantisationTable` **[number][9]** quantization table to use, integer 0-8 (optional, default `0`)
-    *   `options.quantizationTable` **[number][9]** alternative spelling of quantisationTable (optional, default `0`)
-    *   `options.force` **[boolean][7]** force JPEG output, otherwise attempt to use input format (optional, default `true`)
-
-### Examples
-
-```javascript
-// Convert any input to very high quality JPEG output
-const data = await sharp(input)
-  .jpeg({
-    quality: 100,
-    chromaSubsampling: '4:4:4'
-  })
-  .toBuffer();
-```
-
-```javascript
-// Use mozjpeg to reduce output JPEG file size (slower)
-const data = await sharp(input)
-  .jpeg({ mozjpeg: true })
-  .toBuffer();
-```
-
-*   Throws **[Error][4]** Invalid options
-
-Returns **Sharp** 
-
-## png
-
-Use these PNG options for output image.
-
-By default, PNG output is full colour at 8 or 16 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.
-
-### Parameters
-
-*   `options` **[Object][6]?** 
-
-    *   `options.progressive` **[boolean][7]** use progressive (interlace) scan (optional, default `false`)
-    *   `options.compressionLevel` **[number][9]** zlib compression level, 0 (fastest, largest) to 9 (slowest, smallest) (optional, default `6`)
-    *   `options.adaptiveFiltering` **[boolean][7]** use adaptive row filtering (optional, default `false`)
-    *   `options.palette` **[boolean][7]** quantise to a palette-based image with alpha transparency support (optional, default `false`)
-    *   `options.quality` **[number][9]** use the lowest number of colours needed to achieve given quality, sets `palette` to `true` (optional, default `100`)
-    *   `options.effort` **[number][9]** CPU effort, between 1 (fastest) and 10 (slowest), sets `palette` to `true` (optional, default `7`)
-    *   `options.colours` **[number][9]** maximum number of palette entries, sets `palette` to `true` (optional, default `256`)
-    *   `options.colors` **[number][9]** alternative spelling of `options.colours`, sets `palette` to `true` (optional, default `256`)
-    *   `options.dither` **[number][9]** level of Floyd-Steinberg error diffusion, sets `palette` to `true` (optional, default `1.0`)
-    *   `options.force` **[boolean][7]** force PNG output, otherwise attempt to use input format (optional, default `true`)
-
-### Examples
-
-```javascript
-// Convert any input to full colour PNG output
-const data = await sharp(input)
-  .png()
-  .toBuffer();
-```
-
-```javascript
-// Convert any input to indexed PNG output (slower)
-const data = await sharp(input)
-  .png({ palette: true })
-  .toBuffer();
-```
-
-*   Throws **[Error][4]** Invalid options
-
-Returns **Sharp** 
-
-## webp
-
-Use these WebP options for output image.
-
-### Parameters
-
-*   `options` **[Object][6]?** output options
-
-    *   `options.quality` **[number][9]** quality, integer 1-100 (optional, default `80`)
-    *   `options.alphaQuality` **[number][9]** quality of alpha layer, integer 0-100 (optional, default `100`)
-    *   `options.lossless` **[boolean][7]** use lossless compression mode (optional, default `false`)
-    *   `options.nearLossless` **[boolean][7]** use near_lossless compression mode (optional, default `false`)
-    *   `options.smartSubsample` **[boolean][7]** use high quality chroma subsampling (optional, default `false`)
-    *   `options.effort` **[number][9]** CPU effort, between 0 (fastest) and 6 (slowest) (optional, default `4`)
-    *   `options.loop` **[number][9]** number of animation iterations, use 0 for infinite animation (optional, default `0`)
-    *   `options.delay` **([number][9] | [Array][10]<[number][9]>)?** delay(s) between animation frames (in milliseconds)
-    *   `options.force` **[boolean][7]** force WebP output, otherwise attempt to use input format (optional, default `true`)
-
-### Examples
-
-```javascript
-// Convert any input to lossless WebP output
-const data = await sharp(input)
-  .webp({ lossless: true })
-  .toBuffer();
-```
-
-```javascript
-// Optimise the file size of an animated WebP
-const outputWebp = await sharp(inputWebp, { animated: true })
-  .webp({ effort: 6 })
-  .toBuffer();
-```
-
-*   Throws **[Error][4]** Invalid options
-
-Returns **Sharp** 
-
-## gif
-
-Use these GIF options for the output image.
-
-The first entry in the palette is reserved for transparency.
-
-### Parameters
-
-*   `options` **[Object][6]?** output options
-
-    *   `options.colours` **[number][9]** maximum number of palette entries, including transparency, between 2 and 256 (optional, default `256`)
-    *   `options.colors` **[number][9]** alternative spelling of `options.colours` (optional, default `256`)
-    *   `options.effort` **[number][9]** CPU effort, between 1 (fastest) and 10 (slowest) (optional, default `7`)
-    *   `options.dither` **[number][9]** level of Floyd-Steinberg error diffusion, between 0 (least) and 1 (most) (optional, default `1.0`)
-    *   `options.loop` **[number][9]** number of animation iterations, use 0 for infinite animation (optional, default `0`)
-    *   `options.delay` **([number][9] | [Array][10]<[number][9]>)?** delay(s) between animation frames (in milliseconds)
-    *   `options.force` **[boolean][7]** force GIF output, otherwise attempt to use input format (optional, default `true`)
-
-### Examples
-
-```javascript
-// Convert PNG to GIF
-await sharp(pngBuffer)
-  .gif()
-  .toBuffer());
-```
-
-```javascript
-// Convert animated WebP to animated GIF
-await sharp('animated.webp', { animated: true })
-  .toFile('animated.gif');
-```
-
-```javascript
-// 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();
-```
-
-*   Throws **[Error][4]** Invalid options
-
-Returns **Sharp** 
-
-**Meta**
-
-*   **since**: 0.30.0
-
-## jp2
-
-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][11].
-
-### Parameters
-
-*   `options` **[Object][6]?** output options
-
-    *   `options.quality` **[number][9]** quality, integer 1-100 (optional, default `80`)
-    *   `options.lossless` **[boolean][7]** use lossless compression mode (optional, default `false`)
-    *   `options.tileWidth` **[number][9]** horizontal tile size (optional, default `512`)
-    *   `options.tileHeight` **[number][9]** vertical tile size (optional, default `512`)
-    *   `options.chromaSubsampling` **[string][2]** set to '4:2:0' to use chroma subsampling (optional, default `'4:4:4'`)
-
-### Examples
-
-```javascript
-// Convert any input to lossless JP2 output
-const data = await sharp(input)
-  .jp2({ lossless: true })
-  .toBuffer();
-```
-
-```javascript
-// Convert any input to very high quality JP2 output
-const data = await sharp(input)
-  .jp2({
-    quality: 100,
-    chromaSubsampling: '4:4:4'
-  })
-  .toBuffer();
-```
-
-*   Throws **[Error][4]** Invalid options
-
-Returns **Sharp** 
-
-**Meta**
-
-*   **since**: 0.29.1
-
-## tiff
-
-Use these TIFF options for output image.
-
-The `density` can be set in pixels/inch via [withMetadata][1] instead of providing `xres` and `yres` in pixels/mm.
-
-### Parameters
-
-*   `options` **[Object][6]?** output options
-
-    *   `options.quality` **[number][9]** quality, integer 1-100 (optional, default `80`)
-    *   `options.force` **[boolean][7]** force TIFF output, otherwise attempt to use input format (optional, default `true`)
-    *   `options.compression` **[string][2]** compression options: lzw, deflate, jpeg, ccittfax4 (optional, default `'jpeg'`)
-    *   `options.predictor` **[string][2]** compression predictor options: none, horizontal, float (optional, default `'horizontal'`)
-    *   `options.pyramid` **[boolean][7]** write an image pyramid (optional, default `false`)
-    *   `options.tile` **[boolean][7]** write a tiled tiff (optional, default `false`)
-    *   `options.tileWidth` **[number][9]** horizontal tile size (optional, default `256`)
-    *   `options.tileHeight` **[number][9]** vertical tile size (optional, default `256`)
-    *   `options.xres` **[number][9]** horizontal resolution in pixels/mm (optional, default `1.0`)
-    *   `options.yres` **[number][9]** vertical resolution in pixels/mm (optional, default `1.0`)
-    *   `options.resolutionUnit` **[string][2]** resolution unit options: inch, cm (optional, default `'inch'`)
-    *   `options.bitdepth` **[number][9]** reduce bitdepth to 1, 2 or 4 bit (optional, default `8`)
-
-### Examples
-
-```javascript
-// 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 => { ... });
-```
-
-*   Throws **[Error][4]** Invalid options
-
-Returns **Sharp** 
-
-## avif
-
-Use these AVIF options for output image.
-
-Whilst it is possible to create AVIF images smaller than 16x16 pixels,
-most web browsers do not display these properly.
-
-AVIF image sequences are not supported.
-
-### Parameters
-
-*   `options` **[Object][6]?** output options
-
-    *   `options.quality` **[number][9]** quality, integer 1-100 (optional, default `50`)
-    *   `options.lossless` **[boolean][7]** use lossless compression (optional, default `false`)
-    *   `options.effort` **[number][9]** CPU effort, between 0 (fastest) and 9 (slowest) (optional, default `4`)
-    *   `options.chromaSubsampling` **[string][2]** set to '4:2:0' to use chroma subsampling (optional, default `'4:4:4'`)
-
-<!---->
-
-*   Throws **[Error][4]** Invalid options
-
-Returns **Sharp** 
-
-**Meta**
-
-*   **since**: 0.27.0
-
-## heif
-
-Use these HEIF options for output image.
-
-Support for patent-encumbered HEIC images requires the use of a
-globally-installed libvips compiled with support for libheif, libde265 and x265.
-
-### Parameters
-
-*   `options` **[Object][6]?** output options
-
-    *   `options.quality` **[number][9]** quality, integer 1-100 (optional, default `50`)
-    *   `options.compression` **[string][2]** compression format: av1, hevc (optional, default `'av1'`)
-    *   `options.lossless` **[boolean][7]** use lossless compression (optional, default `false`)
-    *   `options.effort` **[number][9]** CPU effort, between 0 (fastest) and 9 (slowest) (optional, default `4`)
-    *   `options.chromaSubsampling` **[string][2]** set to '4:2:0' to use chroma subsampling (optional, default `'4:4:4'`)
-
-<!---->
-
-*   Throws **[Error][4]** Invalid options
-
-Returns **Sharp** 
-
-**Meta**
-
-*   **since**: 0.23.0
-
-## raw
-
-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.
-
-### Parameters
-
-*   `options` **[Object][6]?** output options
-
-    *   `options.depth` **[string][2]** bit depth, one of: char, uchar (default), short, ushort, int, uint, float, complex, double, dpcomplex (optional, default `'uchar'`)
-
-### Examples
-
-```javascript
-// Extract raw, unsigned 8-bit RGB pixel data from JPEG input
-const { data, info } = await sharp('input.jpg')
-  .raw()
-  .toBuffer({ resolveWithObject: true });
-```
-
-```javascript
-// 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();
-```
-
-*   Throws **[Error][4]** Invalid options
-
-## 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
-
-*   `options` **[Object][6]?** 
-
-    *   `options.size` **[number][9]** tile size in pixels, a value between 1 and 8192. (optional, default `256`)
-    *   `options.overlap` **[number][9]** tile overlap in pixels, a value between 0 and 8192. (optional, default `0`)
-    *   `options.angle` **[number][9]** tile angle of rotation, must be a multiple of 90. (optional, default `0`)
-    *   `options.background` **([string][2] | [Object][6])** background colour, parsed by the [color][12] module, defaults to white without transparency. (optional, default `{r:255,g:255,b:255,alpha:1}`)
-    *   `options.depth` **[string][2]?** how deep to make the pyramid, possible values are `onepixel`, `onetile` or `one`, default based on layout.
-    *   `options.skipBlanks` **[number][9]** threshold to skip tile generation, a value 0 - 255 for 8-bit images or 0 - 65535 for 16-bit images (optional, default `-1`)
-    *   `options.container` **[string][2]** tile container, with value `fs` (filesystem) or `zip` (compressed file). (optional, default `'fs'`)
-    *   `options.layout` **[string][2]** filesystem layout, possible values are `dz`, `iiif`, `iiif3`, `zoomify` or `google`. (optional, default `'dz'`)
-    *   `options.centre` **[boolean][7]** centre image in tile. (optional, default `false`)
-    *   `options.center` **[boolean][7]** alternative spelling of centre. (optional, default `false`)
-    *   `options.id` **[string][2]** when `layout` is `iiif`/`iiif3`, sets the `@id`/`id` attribute of `info.json` (optional, default `'https://example.com/iiif'`)
-
-### 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][4]** Invalid parameters
-
-Returns **Sharp** 
-
-## timeout
-
-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.
-
-### Parameters
-
-*   `options` **[Object][6]** 
-
-    *   `options.seconds` **[number][9]** Number of seconds after which processing will be stopped
-
-Returns **Sharp** 
-
-**Meta**
-
-*   **since**: 0.29.2
-
-[1]: #withmetadata
-
-[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
-
-[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
-
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
-
-[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-
-[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[8]: https://nodejs.org/api/buffer.html
-
-[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
-
-[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
-
-[11]: https://sharp.pixelplumbing.com/install#custom-libvips
-
-[12]: https://www.npmjs.org/package/color

docs/api-resize.md

@@ -1,278 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## resize
-
-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, 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][1] CSS property.
-
-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][2] CSS property.
-
-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][3].
-*   `attention`: focus on the region with the highest luminance frequency, colour saturation and presence of skin tones.
-
-Possible interpolation kernels are:
-
-*   `nearest`: Use [nearest neighbour interpolation][4].
-*   `cubic`: Use a [Catmull-Rom spline][5].
-*   `mitchell`: Use a [Mitchell-Netravali spline][6].
-*   `lanczos2`: Use a [Lanczos kernel][7] with `a=2`.
-*   `lanczos3`: Use a Lanczos kernel with `a=3` (the default).
-
-### Parameters
-
-*   `width` **[number][8]?** pixels wide the resultant image should be. Use `null` or `undefined` to auto-scale the width to match the height.
-*   `height` **[number][8]?** pixels high the resultant image should be. Use `null` or `undefined` to auto-scale the height to match the width.
-*   `options` **[Object][9]?** 
-
-    *   `options.width` **[String][10]?** alternative means of specifying `width`. If both are present this take priority.
-    *   `options.height` **[String][10]?** alternative means of specifying `height`. If both are present this take priority.
-    *   `options.fit` **[String][10]** how the image should be resized to fit both provided dimensions, one of `cover`, `contain`, `fill`, `inside` or `outside`. (optional, default `'cover'`)
-    *   `options.position` **[String][10]** position, gravity or strategy to use when `fit` is `cover` or `contain`. (optional, default `'centre'`)
-    *   `options.background` **([String][10] | [Object][9])** background colour when using a `fit` of `contain`, parsed by the [color][11] module, defaults to black without transparency. (optional, default `{r:0,g:0,b:0,alpha:1}`)
-    *   `options.kernel` **[String][10]** the kernel to use for image reduction. (optional, default `'lanczos3'`)
-    *   `options.withoutEnlargement` **[Boolean][12]** do not enlarge if the width *or* height are already less than the specified dimensions, equivalent to GraphicsMagick's `>` geometry option. (optional, default `false`)
-    *   `options.withoutReduction` **[Boolean][12]** do not reduce if the width *or* height are already greater than the specified dimensions, equivalent to GraphicsMagick's `<` geometry option. (optional, default `false`)
-    *   `options.fastShrinkOnLoad` **[Boolean][12]** take greater advantage of the JPEG and WebP shrink-on-load feature, which can lead to a slight moiré pattern on some images. (optional, default `true`)
-
-### Examples
-
-```javascript
-sharp(input)
-  .resize({ width: 100 })
-  .toBuffer()
-  .then(data => {
-    // 100 pixels wide, auto-scaled height
-  });
-```
-
-```javascript
-sharp(input)
-  .resize({ height: 100 })
-  .toBuffer()
-  .then(data => {
-    // 100 pixels high, auto-scaled width
-  });
-```
-
-```javascript
-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
-  });
-```
-
-```javascript
-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);
-```
-
-```javascript
-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
-  });
-```
-
-```javascript
-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
-  });
-```
-
-```javascript
-const scaleByHalf = await sharp(input)
-  .metadata()
-  .then(({ width }) => sharp(input)
-    .resize(Math.round(width * 0.5))
-    .toBuffer()
-  );
-```
-
-*   Throws **[Error][13]** Invalid parameters
-
-Returns **Sharp** 
-
-## extend
-
-Extends/pads the edges of the image with the provided background colour.
-This operation will always occur after resizing and extraction, if any.
-
-### Parameters
-
-*   `extend` **([number][8] | [Object][9])** single pixel count to add to all edges or an Object with per-edge counts
-
-    *   `extend.top` **[number][8]**  (optional, default `0`)
-    *   `extend.left` **[number][8]**  (optional, default `0`)
-    *   `extend.bottom` **[number][8]**  (optional, default `0`)
-    *   `extend.right` **[number][8]**  (optional, default `0`)
-    *   `extend.background` **([String][10] | [Object][9])** background colour, parsed by the [color][11] module, defaults to black without transparency. (optional, default `{r:0,g:0,b:0,alpha:1}`)
-
-### 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)
-  .extend({
-    top: 10,
-    bottom: 20,
-    left: 10,
-    right: 10,
-    background: { r: 0, g: 0, b: 0, alpha: 0 }
-  })
-  ...
-```
-
-```javascript
-// Add a row of 10 red pixels to the bottom
-sharp(input)
-  .extend({
-    bottom: 10,
-    background: 'red'
-  })
-  ...
-```
-
-*   Throws **[Error][13]** Invalid parameters
-
-Returns **Sharp** 
-
-## extract
-
-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` before and after for both.
-
-### Parameters
-
-*   `options` **[Object][9]** describes the region to extract using integral pixel values
-
-    *   `options.left` **[number][8]** zero-indexed offset from left edge
-    *   `options.top` **[number][8]** zero-indexed offset from top edge
-    *   `options.width` **[number][8]** width of region to extract
-    *   `options.height` **[number][8]** height of region to extract
-
-### 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][13]** Invalid parameters
-
-Returns **Sharp** 
-
-## trim
-
-Trim "boring" pixels from all edges that contain values similar to the top-left pixel.
-Images consisting entirely of a single colour will calculate "boring" using the alpha channel, if any.
-
-The `info` response Object, obtained from callback of `.toFile()` or `.toBuffer()`,
-will contain `trimOffsetLeft` and `trimOffsetTop` properties.
-
-### Parameters
-
-*   `threshold` **[number][8]** the allowed difference from the top-left pixel, a number greater than zero. (optional, default `10`)
-
-<!---->
-
-*   Throws **[Error][13]** Invalid parameters
-
-Returns **Sharp** 
-
-[1]: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
-
-[2]: https://developer.mozilla.org/en-US/docs/Web/CSS/object-position
-
-[3]: https://en.wikipedia.org/wiki/Entropy_%28information_theory%29
-
-[4]: http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation
-
-[5]: https://en.wikipedia.org/wiki/Centripetal_Catmull%E2%80%93Rom_spline
-
-[6]: https://www.cs.utexas.edu/~fussell/courses/cs384g-fall2013/lectures/mitchell/Mitchell.pdf
-
-[7]: https://en.wikipedia.org/wiki/Lanczos_resampling#Lanczos_kernel
-
-[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
-
-[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-
-[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[11]: https://www.npmjs.org/package/color
-
-[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error

docs/api-utility.md

@@ -1,201 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## format
-
-An Object containing nested boolean values representing the available input and output formats/methods.
-
-### Examples
-
-```javascript
-console.log(sharp.format);
-```
-
-Returns **[Object][1]** 
-
-## interpolators
-
-An Object containing the available interpolators and their proper values
-
-Type: [string][2]
-
-### nearest
-
-[Nearest neighbour interpolation][3]. Suitable for image enlargement only.
-
-### bilinear
-
-[Bilinear interpolation][4]. Faster than bicubic but with less smooth results.
-
-### bicubic
-
-[Bicubic interpolation][5] (the default).
-
-### locallyBoundedBicubic
-
-[LBB interpolation][6]. Prevents some "[acutance][7]" but typically reduces performance by a factor of 2.
-
-### nohalo
-
-[Nohalo interpolation][8]. Prevents acutance but typically reduces performance by a factor of 3.
-
-### vertexSplitQuadraticBasisSpline
-
-[VSQBS interpolation][9]. Prevents "staircasing" when enlarging.
-
-## versions
-
-An Object containing the version numbers of libvips and its dependencies.
-
-### Examples
-
-```javascript
-console.log(sharp.versions);
-```
-
-## vendor
-
-An Object containing the platform and architecture
-of the current and installed vendored binaries.
-
-### Examples
-
-```javascript
-console.log(sharp.vendor);
-```
-
-## 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][1] | [boolean][10])** Object with the following attributes, or boolean where true uses default cache settings and false removes all caching (optional, default `true`)
-
-    *   `options.memory` **[number][11]** is the maximum memory in MB to use for this cache (optional, default `50`)
-    *   `options.files` **[number][11]** is the maximum number of files to hold open (optional, default `20`)
-    *   `options.items` **[number][11]** 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][1]** 
-
-## 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,
-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.
-
-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][11]?** 
-
-### Examples
-
-```javascript
-const threads = sharp.concurrency(); // 4
-sharp.concurrency(2); // 2
-sharp.concurrency(0); // 4
-```
-
-Returns **[number][11]** concurrency
-
-## 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)');
-});
-```
-
-## 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][1]** 
-
-## 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.
-
-### Parameters
-
-*   `simd` **[boolean][10]**  (optional, default `true`)
-
-### Examples
-
-```javascript
-const simd = sharp.simd();
-// simd is `true` if the runtime use of liborc is currently enabled
-```
-
-```javascript
-const simd = sharp.simd(false);
-// prevent libvips from using liborc at runtime
-```
-
-Returns **[boolean][10]** 
-
-[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-
-[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[3]: http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation
-
-[4]: http://en.wikipedia.org/wiki/Bilinear_interpolation
-
-[5]: http://en.wikipedia.org/wiki/Bicubic_interpolation
-
-[6]: https://github.com/jcupitt/libvips/blob/master/libvips/resample/lbb.cpp#L100
-
-[7]: http://en.wikipedia.org/wiki/Acutance
-
-[8]: http://eprints.soton.ac.uk/268086/
-
-[9]: https://github.com/jcupitt/libvips/blob/master/libvips/resample/vsqbs.cpp#L48
-
-[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

docs/astro.config.mjs

@@ -0,0 +1,90 @@
+// @ts-check
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+import starlightAutoSidebar from 'starlight-auto-sidebar';
+
+import { version } from '../package.json';
+
+export default defineConfig({
+  site: 'https://sharp.pixelplumbing.com',
+  integrations: [
+    starlight({
+      title: 'sharp',
+      description:
+        'High performance Node.js image processing. The fastest module to resize JPEG, PNG, WebP and TIFF images.',
+      logo: {
+        src: './src/assets/sharp-logo.svg',
+        alt: '#'
+      },
+      customCss: ['./src/styles/custom.css'],
+      head: [{
+        tag: 'meta',
+        attrs: {
+          'http-equiv': 'Content-Security-Policy',
+          content: "default-src 'self'; connect-src 'self'; object-src 'none'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; script-src 'self' 'unsafe-inline' 'unsafe-eval' https://static.cloudflareinsights.com/beacon.min.js/;"
+        }
+      }, {
+        tag: 'link',
+        attrs: {
+          rel: 'author',
+          href: '/humans.txt',
+          type: 'text/plain'
+        }
+      }, {
+        tag: 'script',
+        attrs: {
+          type: 'application/ld+json'
+        },
+        content: JSON.stringify({
+          '@context': 'https://schema.org',
+          '@type': 'SoftwareSourceCode',
+          name: 'sharp',
+          description: 'High performance Node.js image processing',
+          url: 'https://sharp.pixelplumbing.com',
+          codeRepository: 'https://github.com/lovell/sharp',
+          programmingLanguage: ['JavaScript', 'C++'],
+          runtimePlatform: 'Node.js',
+          copyrightHolder: {
+            '@context': 'https://schema.org',
+            '@type': 'Person',
+            name: 'Lovell Fuller'
+          },
+          copyrightYear: 2013,
+          license: 'https://www.apache.org/licenses/LICENSE-2.0'
+        })
+      }],
+      sidebar: [
+        { label: 'Home', link: '/' },
+        { label: 'Installation', slug: 'install' },
+        {
+          label: 'API',
+          items: [
+            { label: 'Constructor', slug: 'api-constructor' },
+            { label: 'Input metadata', slug: 'api-input' },
+            { label: 'Output options', slug: 'api-output' },
+            { label: 'Resizing images', slug: 'api-resize' },
+            { label: 'Compositing images', slug: 'api-composite' },
+            { label: 'Image operations', slug: 'api-operation' },
+            { label: 'Colour manipulation', slug: 'api-colour' },
+            { label: 'Channel manipulation', slug: 'api-channel' },
+            { label: 'Global properties', slug: 'api-utility' }
+          ]
+        },
+        { label: 'Performance', slug: 'performance' },
+        {
+          label: 'Changelog',
+          collapsed: true,
+          autogenerate: { directory: 'changelog' }
+        }
+      ],
+      social: [
+        { icon: 'openCollective', label: 'Open Collective', href: 'https://opencollective.com/libvips' },
+        { icon: 'github', label: 'GitHub', href: 'https://github.com/lovell/sharp' }
+      ],
+      plugins: [starlightAutoSidebar()]
+    })
+  ],
+  redirects: {
+    '/changelog': `/changelog/v${version}`
+  }
+});

docs/build.js

@@ -1,25 +0,0 @@
-'use strict';
-
-const fs = require('fs').promises;
-const path = require('path');
-const documentation = require('documentation');
-
-[
-  'constructor',
-  'input',
-  'resize',
-  'composite',
-  'operation',
-  'colour',
-  'channel',
-  'output',
-  'utility'
-].forEach(async (m) => {
-  const input = path.join('lib', `${m}.js`);
-  const output = path.join('docs', `api-${m}.md`);
-
-  const ast = await documentation.build(input, { shallow: true });
-  const markdown = await documentation.formats.md(ast, { markdownToc: false });
-
-  await fs.writeFile(output, markdown);
-});

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/firebase.json

@@ -1,14 +1,7 @@
 {
   "hosting": {
     "site": "pixelplumbing-sharp",
-    "public": ".",
-    "ignore": [
-      ".*",
-      "build.js",
-      "firebase.json",
-      "image/**",
-      "search-index/**"
-    ],
+    "public": "dist",
     "headers": [
       {
         "source": "**",
@@ -18,99 +11,6 @@
           { "key": "X-Frame-Options", "value": "SAMEORIGIN" }
         ]
       }
-    ],
-    "redirects": [
-      {
-        "source": "**/install/**",
-        "destination": "/install",
-        "type": 301
-      },
-      {
-        "source": "/page/install",
-        "destination": "/install",
-        "type": 301
-      },
-      {
-        "source": "**/api-constructor/**",
-        "destination": "/api-constructor",
-        "type": 301
-      },
-      {
-        "source": "**/api-input/**",
-        "destination": "/api-input",
-        "type": 301
-      },
-      {
-        "source": "**/api-output/**",
-        "destination": "/api-output",
-        "type": 301
-      },
-      {
-        "source": "**/api-resize/**",
-        "destination": "/api-resize",
-        "type": 301
-      },
-      {
-        "source": "**/api-compsite/**",
-        "destination": "/api-compsite",
-        "type": 301
-      },
-      {
-        "source": "**/api-operation/**",
-        "destination": "/api-operation",
-        "type": 301
-      },
-      {
-        "source": "**/api-colour/**",
-        "destination": "/api-colour",
-        "type": 301
-      },
-      {
-        "source": "**/api-channel/**",
-        "destination": "/api-channel",
-        "type": 301
-      },
-      {
-        "source": "**/api-utility/**",
-        "destination": "/api-utility",
-        "type": 301
-      },
-      {
-        "source": "/page/api",
-        "destination": "/api-constructor",
-        "type": 301
-      },
-      {
-        "source": "**/performance/**",
-        "destination": "/performance",
-        "type": 301
-      },
-      {
-        "source": "/page/performance",
-        "destination": "/performance",
-        "type": 301
-      },
-      {
-        "source": "**/changelog/**",
-        "destination": "/changelog",
-        "type": 301
-      },
-      {
-        "source": "/page/changelog",
-        "destination": "/changelog",
-        "type": 301
-      },
-      {
-        "source": "/en/**",
-        "destination": "/",
-        "type": 301
-      }
-    ],
-    "rewrites": [
-      {
-        "source": "**",
-        "destination": "/index.html"
-      }
     ]
   }
 }

docs/install.md

@@ -1,246 +0,0 @@
-# Installation
-
-```sh
-npm install sharp
-```
-
-```sh
-yarn add sharp
-```
-
-## Prerequisites
-
-* Node.js >= 12.13.0
-
-## Prebuilt binaries
-
-Ready-compiled sharp and libvips binaries are provided for use on the most common platforms:
-
-* macOS x64 (>= 10.13)
-* macOS ARM64
-* Linux x64 (glibc >= 2.17, musl >= 1.1.24, CPU with SSE4.2)
-* Linux ARM64 (glibc >= 2.17, musl >= 1.1.24)
-* Windows x64
-* Windows x86
-
-A ~7MB tarball containing libvips and its most commonly used dependencies
-is downloaded via HTTPS, verified via Subresource Integrity
-and decompressed into `node_modules/sharp/vendor` during `npm install`.
-
-This provides support for the
-JPEG, PNG, WebP, AVIF, TIFF, GIF and SVG (input) image formats.
-
-The following platforms have prebuilt libvips but not sharp:
-
-* Linux ARMv7 (glibc >= 2.28)
-* Linux ARMv6 (glibc >= 2.28)
-* Windows ARM64
-
-The following platforms require compilation of both libvips and sharp from source:
-
-* Linux x86
-* Linux ARMv7 (glibc <= 2.27, musl)
-* Linux ARMv6 (glibc <= 2.27, musl)
-* Linux PowerPC
-* FreeBSD
-* OpenBSD
-
-## Common problems
-
-The architecture and platform of Node.js used for `npm install`
-must be the same as the architecture and platform of Node.js used at runtime.
-See the [cross-platform](#cross-platform) section if this is not the case.
-
-When using npm v6 or earlier, the `npm install --unsafe-perm` flag must be used when installing as `root` or a `sudo` user.
-
-When using npm v7 or later, the user running `npm install` must own the directory it is run in.
-
-The `npm install --ignore-scripts=false` flag must be used when `npm` has been configured to ignore installation scripts.
-
-Check the output of running `npm install --verbose sharp` for useful error messages.
-
-## Apple M1
-
-Prebuilt sharp and libvips binaries have been provided for macOS on ARM64 since sharp v0.29.0.
-
-## Cross-platform
-
-At `npm install` time, prebuilt binaries are automatically selected for the
-current OS platform and CPU architecture, where available.
-
-The target platform and/or architecture can be manually selected using the following flags.
-
-```sh
-npm install --platform=... --arch=... --arm-version=... sharp
-```
-
-* `--platform`: one of `linux`, `linuxmusl`, `darwin` or `win32`.
-* `--arch`: one of `x64`, `ia32`, `arm` or `arm64`.
-* `--arm-version`: one of `6`, `7` or `8` (`arm` defaults to `6`, `arm64` defaults to `8`).
-* `--sharp-install-force`: skip version compatibility and Subresource Integrity checks.
-
-These values can also be set via environment variables,
-`npm_config_platform`, `npm_config_arch`, `npm_config_arm_version`
-and `SHARP_INSTALL_FORCE` respectively.
-
-For example, if the target machine has a 64-bit ARM CPU and is running Alpine Linux,
-use the following flags:
-
-```sh
-npm install --arch=arm64 --platform=linuxmusl sharp
-```
-
-## 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 from source, please see
-[https://libvips.github.io/libvips/install.html#building-libvips-from-a-source-tarball](https://libvips.github.io/libvips/install.html#building-libvips-from-a-source-tarball).
-
-The use of a globally-installed libvips is unsupported on Windows.
-
-## Building from source
-
-This module will be compiled from source at `npm install` time when:
-
-* a globally-installed libvips is detected (set the `SHARP_IGNORE_GLOBAL_LIBVIPS` environment variable to skip this),
-* prebuilt sharp binaries do not exist for the current platform, or
-* when the `npm install --build-from-source` flag is used.
-
-Building from source requires:
-
-* C++11 compiler
-* [node-gyp](https://github.com/nodejs/node-gyp#installation) and its dependencies
-
-## Custom prebuilt binaries
-
-This is an advanced approach that most people will not require.
-
-To install the prebuilt sharp binaries from a custom URL,
-set the `sharp_binary_host` npm config option
-or the `npm_config_sharp_binary_host` environment variable.
-
-To install the prebuilt sharp binaries from a directory on the local filesystem,
-set the `sharp_local_prebuilds` npm config option
-or the `npm_config_sharp_local_prebuilds` environment variable.
-
-To install the prebuilt libvips binaries from a custom URL,
-set the `sharp_libvips_binary_host` npm config option
-or the `npm_config_sharp_libvips_binary_host` environment variable.
-
-The version subpath and file name are appended to these.
-For example, if `sharp_libvips_binary_host` is set to `https://hostname/path`
-and the libvips version is `1.2.3` then the resultant URL will be
-`https://hostname/path/v1.2.3/libvips-1.2.3-platform-arch.tar.br`.
-
-See the Chinese mirror below for a further example.
-
-## Chinese mirror
-
-A mirror site based in China, provided by Alibaba, contains binaries for both sharp and libvips.
-
-To use this either set the following configuration:
-
-```sh
-npm config set sharp_binary_host "https://npmmirror.com/mirrors/sharp"
-npm config set sharp_libvips_binary_host "https://npmmirror.com/mirrors/sharp-libvips"
-npm install sharp
-```
-
-or set the following environment variables:
-
-```sh
-npm_config_sharp_binary_host="https://npmmirror.com/mirrors/sharp" \
-  npm_config_sharp_libvips_binary_host="https://npmmirror.com/mirrors/sharp-libvips" \
-  npm install 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.
-
-## Heroku
-
-Add the
-[jemalloc buildpack](https://github.com/gaffneyc/heroku-buildpack-jemalloc)
-to reduce the effects of memory fragmentation.
-
-Set
-[NODE_MODULES_CACHE](https://devcenter.heroku.com/articles/nodejs-support#cache-behavior)
-to `false` when using the `yarn` package manager.
-
-## 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 the Linux x64 platform.
-
-When building your deployment package on machines other than Linux x64 (glibc),
-run the following additional command after `npm install`:
-
-```sh
-npm install
-SHARP_IGNORE_GLOBAL_LIBVIPS=1 npm install --arch=x64 --platform=linux sharp
-```
-
-To get the best performance select the largest memory available.
-A 1536 MB function provides ~12x more CPU time than a 128 MB function.
-
-## Webpack
-
-Ensure sharp is added to the
-[externals](https://webpack.js.org/configuration/externals/)
-configuration.
-
-```js
-externals: {
-  'sharp': 'commonjs sharp'
-}
-```
-
-## Worker threads
-
-The main thread must call `require('sharp')`
-before worker threads are created
-to ensure shared libraries remain loaded in memory
-until after all threads are complete.
-
-## Known conflicts
-
-### Canvas and Windows
-
-The prebuilt binaries provided by `canvas` for Windows depend on the unmaintained GTK 2, last updated in 2011.
-
-These conflict with the modern, up-to-date binaries provided by sharp.
-
-If both modules are used in the same Windows process, the following error will occur:
-```
-The specified procedure could not be found.
-```

docs/package.json

@@ -0,0 +1,18 @@
+{
+  "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.34.6",
+    "astro": "^5.11.1",
+    "starlight-auto-sidebar": "^0.1.2"
+  }
+}

docs/performance.md

@@ -1,72 +0,0 @@
-# Performance
-
-A test to benchmark the performance of this module relative to alternatives.
-
-## The contenders
-
-* [jimp](https://www.npmjs.com/package/jimp) v0.16.1 - Image processing in pure JavaScript. Provides bicubic interpolation.
-* [mapnik](https://www.npmjs.org/package/mapnik) v4.5.9 - Whilst primarily a map renderer, Mapnik contains bitmap image utilities.
-* [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.1 - Fully featured wrapper around GraphicsMagick's `gm` command line utility.
-* [@squoosh/lib](https://www.npmjs.com/package/@squoosh/lib) v0.4.0 - Image libraries transpiled to WebAssembly, includes GPLv3 code.
-* [@squoosh/cli](https://www.npmjs.com/package/@squoosh/cli) v0.7.2 - Command line wrapper around `@squoosh/lib`, avoids GPLv3 by spawning process.
-* sharp v0.30.0 / libvips v8.12.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.
-
-## Test environment
-
-* AWS EC2 eu-west-1 [c5ad.xlarge](https://aws.amazon.com/ec2/instance-types/c5/) (4x AMD EPYC 7R32)
-* Ubuntu 21.10 (ami-0258eeb71ddf238b3)
-* Node.js 16.13.2
-
-## Results
-
-| Module             | Input  | Output | Ops/sec | Speed-up |
-| :----------------- | :----- | :----- | ------: | -------: |
-| jimp               | buffer | buffer |    0.84 |      1.0 |
-| squoosh-cli        | file   | file   |    1.08 |      1.3 |
-| squoosh-lib        | buffer | buffer |    1.85 |      2.2 |
-| mapnik             | buffer | buffer |    3.45 |      4.1 |
-| gm                 | buffer | buffer |    8.60 |     10.2 |
-| gm                 | file   | file   |    8.66 |     10.3 |
-| imagemagick        | file   | file   |    8.79 |     10.5 |
-| sharp              | stream | stream |   28.90 |     34.4 |
-| sharp              | file   | file   |   30.08 |     35.8 |
-| sharp              | buffer | buffer |   30.42 |     36.2 |
-
-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.
-
-## Running the benchmark test
-
-Requires _ImageMagick_, _GraphicsMagick_ and _Mapnik_:
-
-```sh
-brew install imagemagick
-brew install graphicsmagick
-brew install mapnik
-```
-
-```sh
-sudo apt-get install build-essential imagemagick libmagick++-dev graphicsmagick libmapnik-dev
-```
-
-```sh
-sudo yum install ImageMagick-devel ImageMagick-c++-devel GraphicsMagick mapnik-devel
-```
-
-```sh
-git clone https://github.com/lovell/sharp.git
-cd sharp
-npm install --build-from-source
-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/humans.txt

@@ -28,7 +28,7 @@ Name: Brandon Aaron
 GitHub: https://github.com/brandonaaron
 
 Name: Andreas Lind
-GitHub: https://github.com/papandreouGitHub:
+GitHub: https://github.com/papandreou
 
 Name: Maurus Cuelenaere
 GitHub: https://github.com/mcuelenaere
@@ -236,3 +236,90 @@ GitHub: https://github.com/gforge
 
 Name: Chris Banks
 GitHub: https://github.com/christopherbradleybanks
+
+Name: codepage949
+GitHub: https://github.com/codepage949
+
+Name: Chris Hranj
+GitHub: https://github.com/Brodan
+
+Name: Ankur Parihar
+GitHub: https://github.com/ankurparihar
+
+Name: Joona Heinikoski
+GitHub: https://github.com/joonamo
+
+Name: AlexanderTheGrey
+GitHub: https://github.com/AlexanderTheGrey
+
+Name: Blayne Chard
+GitHub: https://github.com/blacha
+
+Name: Brahim
+GitHub: https://github.com/brahima
+
+Name: Anton Marsden
+GitHub: https://github.com/antonmarsden
+
+Name: Marcos Casagrande
+GitHub: https://github.com/marcosc90
+
+Name: Emanuel Jöbstl
+GitHub: https://github.com/ejoebstl
+
+Name: Tomasz Janowski
+GitHub: https://github.com/janaz
+
+Name: Lachlan Newman
+GitHub: https://github.com/LachlanNewman
+
+Name: BJJ
+GitHub: https://github.com/bianjunjie1981
+
+Name: Dennis Beatty
+GitHub: https://github.com/dnsbty
+
+Name: Ingvar Stepanyan
+GitHub: https://github.com/RReverser
+
+Name: Tamás András Horváth
+GitHub: https://github.com/icetee
+
+Name: Aaron Che
+GitHub: https://github.com/yolopunk
+
+Name: Mert Alev
+GitHub: https://github.com/mertalev
+
+Name: Adriaan Meuris
+GitHub: https://github.com/adriaanmeuris
+
+Name: Richard Hillmann
+GitHub: https://github.com/project0
+
+Name: Pongsatorn Manusopit
+GitHub: https://github.com/ton11797
+
+Name: Nathan Keynes
+GitHub: https://github.com/nkeynes
+
+Name: Sumit D
+GitHub: https://github.com/sumitd2
+
+Name: Caleb Meredith
+GitHub: https://github.com/calebmer
+
+Name: Don Denton
+GitHub: https://github.com/happycollision
+
+Name: Florent Zabera
+GitHub: https://github.com/florentzabera
+
+Name: Quentin Pinçon
+GitHub: https://github.com/qpincon
+
+Name: Hans Chen
+GitHub: https://github.com/hans00
+
+Name: Thibaut Patel
+GitHub: https://github.com/tpatel

docs/public/robots.txt

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

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/robots.txt

@@ -1,2 +0,0 @@
-User-agent: *
-Disallow:

docs/search-index/build.js

@@ -1,61 +0,0 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const { extractDescription, extractKeywords, extractParameters } = require('./extract');
-
-const searchIndex = [];
-
-// Install
-const contents = fs.readFileSync(path.join(__dirname, '..', 'install.md'), 'utf8');
-const matches = contents.matchAll(
-  /## (?<title>[A-Za-z0-9 ]+)\n\n(?<body>[^#]+)/gs
-);
-for (const match of matches) {
-  const { title, body } = match.groups;
-  const description = extractDescription(body);
-
-  searchIndex.push({
-    t: title,
-    d: description,
-    k: extractKeywords(`${title} ${description}`),
-    l: `/install#${title.toLowerCase().replace(/ /g, '-')}`
-  });
-}
-
-// API
-[
-  'constructor',
-  'input',
-  'output',
-  'resize',
-  'composite',
-  'operation',
-  'channel',
-  'colour',
-  'utility'
-].forEach((section) => {
-  const contents = fs.readFileSync(path.join(__dirname, '..', `api-${section}.md`), 'utf8');
-  const matches = contents.matchAll(
-    /\n## (?<title>[A-Za-z]+)\n\n(?<firstparagraph>.+?)\n\n(?<parameters>### Parameters.+?Returns)?/gs
-  );
-  for (const match of matches) {
-    const { title, firstparagraph, parameters } = match.groups;
-    const description = firstparagraph.startsWith('###')
-      ? 'Constructor'
-      : extractDescription(firstparagraph);
-    const parameterNames = parameters ? extractParameters(parameters) : '';
-
-    searchIndex.push({
-      t: title,
-      d: description,
-      k: extractKeywords(`${title} ${description} ${parameterNames}`),
-      l: `/api-${section}#${title.toLowerCase()}`
-    });
-  }
-});
-
-fs.writeFileSync(
-  path.join(__dirname, '..', 'search-index.json'),
-  JSON.stringify(searchIndex)
-);

docs/search-index/extract.js

@@ -1,30 +0,0 @@
-'use strict';
-
-const stopWords = require('./stop-words');
-
-const extractDescription = (str) =>
-  str
-    .replace(/### Examples.*/sg, '')
-    .replace(/\(http[^)]+/g, '')
-    .replace(/\s+/g, ' ')
-    .replace(/[^A-Za-z0-9_/\-,. ]/g, '')
-    .replace(/\s+/g, ' ')
-    .substr(0, 180)
-    .trim();
-
-const extractParameters = (str) =>
-  [...str.matchAll(/options\.(?<name>[^.`]+)/gs)]
-    .map((match) => match.groups.name)
-    .join(' ');
-
-const extractKeywords = (str) =>
-  [
-    ...new Set(
-      str
-        .split(/[ -/]/)
-        .map((word) => word.toLowerCase().replace(/[^a-z]/g, ''))
-        .filter((word) => word.length > 2 && word.length < 15 && !stopWords.includes(word))
-    )
-  ].join(' ');
-
-module.exports = { extractDescription, extractKeywords, extractParameters };

docs/search-index/stop-words.js

@@ -1,115 +0,0 @@
-'use strict';
-
-module.exports = [
-  'about',
-  'after',
-  'all',
-  'allows',
-  'already',
-  'also',
-  'alternative',
-  'always',
-  'and',
-  'any',
-  'are',
-  'based',
-  'been',
-  'before',
-  'both',
-  'call',
-  'callback',
-  'can',
-  'containing',
-  'contains',
-  'current',
-  'date',
-  'default',
-  'does',
-  'each',
-  'either',
-  'ensure',
-  'entirely',
-  'etc',
-  'every',
-  'except',
-  'following',
-  'for',
-  'from',
-  'get',
-  'gets',
-  'given',
-  'has',
-  'have',
-  'how',
-  'image',
-  'implies',
-  'involve',
-  'its',
-  'last',
-  'least',
-  'lots',
-  'make',
-  'may',
-  'more',
-  'most',
-  'much',
-  'must',
-  'non',
-  'not',
-  'occur',
-  'occurs',
-  'options',
-  'other',
-  'out',
-  'over',
-  'perform',
-  'performs',
-  'produce',
-  'provide',
-  'provided',
-  'ready',
-  'requires',
-  'returned',
-  'same',
-  'see',
-  'set',
-  'sets',
-  'should',
-  'since',
-  'site',
-  'specified',
-  'spelling',
-  'such',
-  'support',
-  'supported',
-  'sure',
-  'take',
-  'task',
-  'than',
-  'that',
-  'the',
-  'their',
-  'then',
-  'there',
-  'therefore',
-  'these',
-  'this',
-  'under',
-  'unless',
-  'unmaintained',
-  'unsuitable',
-  'until',
-  'use',
-  'used',
-  'using',
-  'value',
-  'values',
-  'were',
-  'when',
-  'which',
-  'while',
-  'will',
-  'with',
-  'without',
-  'you'
-];

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,10 @@
+import { defineCollection } from 'astro:content';
+import { docsLoader } from '@astrojs/starlight/loaders';
+import { docsSchema } from '@astrojs/starlight/schema';
+import { autoSidebarLoader } from 'starlight-auto-sidebar/loader'
+import { autoSidebarSchema } from 'starlight-auto-sidebar/schema'
+
+export const collections = {
+	docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
+	autoSidebar: defineCollection({ loader: autoSidebarLoader(), schema: autoSidebarSchema() })
+};

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

@@ -1,14 +1,18 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+---
+# This file was auto-generated from JSDoc in lib/channel.js
+title: Channel manipulation
+---
 
 ## removeAlpha
+> removeAlpha() ⇒ <code>Sharp</code>
 
-Remove alpha channel, if any. This is a no-op if the image does not have an alpha channel.
+Remove alpha channels, if any. This is a no-op if the image does not have an alpha channel.
 
-See also [flatten][1].
+See also [flatten](/api-operation#flatten).
 
-### Examples
 
-```javascript
+**Example**  
+```js
 sharp('rgba.png')
   .removeAlpha()
   .toFile('rgb.png', function(err, info) {
@@ -16,61 +20,66 @@ sharp('rgba.png')
   });
 ```
 
-Returns **Sharp** 
 
 ## 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.
 
-### Parameters
 
-*   `alpha` **[number][2]** alpha transparency level (0=fully-transparent, 1=fully-opaque) (optional, default `1`)
+**Throws**:
 
-### Examples
+- <code>Error</code> Invalid alpha transparency level
 
-```javascript
+**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')
 ```
-
-```javascript
+**Example**  
+```js
 // rgba is a 4 channel image with a fully-transparent alpha channel
 const rgba = await sharp(rgb)
   .ensureAlpha(0)
   .toBuffer();
 ```
 
-*   Throws **[Error][3]** Invalid alpha transparency level
-
-Returns **Sharp** 
-
-**Meta**
-
-*   **since**: 0.21.2
 
 ## extractChannel
+> extractChannel(channel) ⇒ <code>Sharp</code>
 
 Extract a single channel from a multi-channel image.
 
-### Parameters
 
-*   `channel` **([number][2] | [string][4])** zero-indexed channel/band number to extract, or `red`, `green`, `blue` or `alpha`.
+**Throws**:
 
-### Examples
+- <code>Error</code> Invalid channel
 
-```javascript
+
+| 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');
 ```
-
-```javascript
+**Example**  
+```js
 // red1 is the red value of the first pixel, red2 the second pixel etc.
 const [red1, red2, ...] = await sharp(input)
   .extractChannel(0)
@@ -78,45 +87,50 @@ const [red1, red2, ...] = await sharp(input)
   .toBuffer();
 ```
 
-*   Throws **[Error][3]** Invalid channel
-
-Returns **Sharp** 
 
 ## 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.
+- 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.
 
-### Parameters
 
-*   `images` **([Array][5]<([string][4] | [Buffer][6])> | [string][4] | [Buffer][6])** one or more images (file paths, Buffers).
-*   `options` **[Object][7]** image options, see `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. |
 
-*   Throws **[Error][3]** Invalid parameters
 
-Returns **Sharp** 
 
 ## bandbool
+> bandbool(boolOp) ⇒ <code>Sharp</code>
 
 Perform a bitwise boolean operation on all input image channels (bands) to produce a single channel output image.
 
-### Parameters
 
-*   `boolOp` **[string][4]** one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
+**Throws**:
 
-### Examples
+- <code>Error</code> Invalid parameters
 
-```javascript
+
+| 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) {
@@ -124,22 +138,4 @@ sharp('3-channel-rgb-input.png')
     // If `I(1,1) = [247, 170, 14] = [0b11110111, 0b10101010, 0b00001111]`
     // then `O(1,1) = 0b11110111 & 0b10101010 & 0b00001111 = 0b00000010 = 2`.
   });
-```
-
-*   Throws **[Error][3]** Invalid parameters
-
-Returns **Sharp** 
-
-[1]: /api-operation#flatten
-
-[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
-
-[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
-
-[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
-
-[6]: https://nodejs.org/api/buffer.html
-
-[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+```

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,274 @@
+---
+# 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.animated] | <code>boolean</code> | <code>false</code> | Set to `true` to read all frames/pages of an animated image (GIF, WebP, TIFF), equivalent of setting `pages` to `-1`. |
+| [options.raw] | <code>Object</code> |  | describes raw pixel input image data. See `raw()` for pixel ordering. |
+| [options.raw.width] | <code>number</code> |  | integral number of pixels wide. |
+| [options.raw.height] | <code>number</code> |  | integral number of pixels high. |
+| [options.raw.channels] | <code>number</code> |  | integral number of channels, between 1 and 4. |
+| [options.raw.premultiplied] | <code>boolean</code> |  | specifies that the raw input has already been premultiplied, set to `true`  to avoid sharp premultiplying the image. (optional, default `false`) |
+| [options.raw.pageHeight] | <code>number</code> |  | The pixel height of each page/frame for animated images, must be an integral factor of `raw.height`. |
+| [options.create] | <code>Object</code> |  | describes a new image to be created. |
+| [options.create.width] | <code>number</code> |  | integral number of pixels wide. |
+| [options.create.height] | <code>number</code> |  | integral number of pixels high. |
+| [options.create.channels] | <code>number</code> |  | integral number of channels, either 3 (RGB) or 4 (RGBA). |
+| [options.create.background] | <code>string</code> \| <code>Object</code> |  | parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha. |
+| [options.create.pageHeight] | <code>number</code> |  | The pixel height of each page/frame for animated images, must be an integral factor of `create.height`. |
+| [options.create.noise] | <code>Object</code> |  | describes a noise to be created. |
+| [options.create.noise.type] | <code>string</code> |  | type of generated noise, currently only `gaussian` is supported. |
+| [options.create.noise.mean] | <code>number</code> | <code>128</code> | Mean value of pixels in the generated noise. |
+| [options.create.noise.sigma] | <code>number</code> | <code>30</code> | Standard deviation of pixel values in the generated noise. |
+| [options.text] | <code>Object</code> |  | describes a new text image to be created. |
+| [options.text.text] | <code>string</code> |  | text to render as a UTF-8 string. It can contain Pango markup, for example `<i>Le</i>Monde`. |
+| [options.text.font] | <code>string</code> |  | font name to render with. |
+| [options.text.fontfile] | <code>string</code> |  | absolute filesystem path to a font file that can be used by `font`. |
+| [options.text.width] | <code>number</code> | <code>0</code> | Integral number of pixels to word-wrap at. Lines of text wider than this will be broken at word boundaries. |
+| [options.text.height] | <code>number</code> | <code>0</code> | Maximum integral number of pixels high. When defined, `dpi` will be ignored and the text will automatically fit the pixel resolution defined by `width` and `height`. Will be ignored if `width` is not specified or set to 0. |
+| [options.text.align] | <code>string</code> | <code>&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'`). |
+| [options.tiff] | <code>Object</code> |  | Describes TIFF specific options. |
+| [options.tiff.subifd] | <code>number</code> | <code>-1</code> | Sub Image File Directory to extract for OME-TIFF, defaults to main image. |
+| [options.svg] | <code>Object</code> |  | Describes SVG specific options. |
+| [options.svg.stylesheet] | <code>string</code> |  | Custom CSS for SVG input, applied with a User Origin during the CSS cascade. |
+| [options.svg.highBitdepth] | <code>boolean</code> | <code>false</code> | Set to `true` to render SVG input at 32-bits per channel (128-bit) instead of 8-bits per channel (32-bit) RGBA. |
+| [options.pdf] | <code>Object</code> |  | Describes PDF specific options. Requires the use of a globally-installed libvips compiled with support for PDFium, Poppler, ImageMagick or GraphicsMagick. |
+| [options.pdf.background] | <code>string</code> \| <code>Object</code> |  | Background colour to use when PDF is partially transparent. Parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha. |
+| [options.openSlide] | <code>Object</code> |  | Describes OpenSlide specific options. Requires the use of a globally-installed libvips compiled with support for OpenSlide. |
+| [options.openSlide.level] | <code>number</code> | <code>0</code> | Level to extract from a multi-level input, zero based. |
+| [options.jp2] | <code>Object</code> |  | Describes JPEG 2000 specific options. Requires the use of a globally-installed libvips compiled with support for OpenJPEG. |
+| [options.jp2.oneshot] | <code>boolean</code> | <code>false</code> | Set to `true` to decode tiled JPEG 2000 images in a single operation, improving compatibility. |
+
+**Example**  
+```js
+sharp('input.jpg')
+  .resize(300, 200)
+  .toFile('output.jpg', function(err) {
+    // output.jpg is a 300 pixels wide and 200 pixels high image
+    // containing a scaled and cropped version of input.jpg
+  });
+```
+**Example**  
+```js
+// Read image data from remote URL,
+// resize to 300 pixels wide,
+// emit an 'info' event with calculated dimensions
+// and finally write image data to writableStream
+const { body } = fetch('https://...');
+const readableStream = Readable.fromWeb(body);
+const transformer = sharp()
+  .resize(300)
+  .on('info', ({ height }) => {
+    console.log(`Image height is ${height}`);
+  });
+readableStream.pipe(transformer).pipe(writableStream);
+```
+**Example**  
+```js
+// Create a blank 300x200 PNG image of semi-translucent red pixels
+sharp({
+  create: {
+    width: 300,
+    height: 200,
+    channels: 4,
+    background: { r: 255, g: 0, b: 0, alpha: 0.5 }
+  }
+})
+.png()
+.toBuffer()
+.then( ... );
+```
+**Example**  
+```js
+// Convert an animated GIF to an animated WebP
+await sharp('in.gif', { animated: true }).toFile('out.webp');
+```
+**Example**  
+```js
+// Read a raw array of pixels and save it to a png
+const input = Uint8Array.from([255, 255, 255, 0, 0, 0]); // or Uint8ClampedArray
+const image = sharp(input, {
+  // because the input does not contain its dimensions or how many channels it has
+  // we need to specify it in the constructor options
+  raw: {
+    width: 2,
+    height: 1,
+    channels: 3
+  }
+});
+await image.toFile('my-two-pixels.png');
+```
+**Example**  
+```js
+// Generate RGB Gaussian noise
+await sharp({
+  create: {
+    width: 300,
+    height: 200,
+    channels: 3,
+    noise: {
+      type: 'gaussian',
+      mean: 128,
+      sigma: 30
+    }
+ }
+}).toFile('noise.png');
+```
+**Example**  
+```js
+// Generate an image from text
+await sharp({
+  text: {
+    text: 'Hello, world!',
+    width: 400, // max width
+    height: 300 // max height
+  }
+}).toFile('text_bw.png');
+```
+**Example**  
+```js
+// Generate an rgba image from text using pango markup and font
+await sharp({
+  text: {
+    text: '<span foreground="red">Red!</span><span background="cyan">blue</span>',
+    font: 'sans',
+    rgba: true,
+    dpi: 300
+  }
+}).toFile('text_rgba.png');
+```
+**Example**  
+```js
+// Join four input images as a 2x2 grid with a 4 pixel gutter
+const data = await sharp(
+ [image1, image2, image3, image4],
+ { join: { across: 2, shim: 4 } }
+).toBuffer();
+```
+**Example**  
+```js
+// Generate a two-frame animated image from emoji
+const images = ['😀', '😛'].map(text => ({
+  text: { text, width: 64, height: 64, channels: 4, rgba: true }
+}));
+await sharp(images, { join: { animated: true } }).toFile('out.gif');
+```
+
+
+## clone
+> clone() ⇒ [<code>Sharp</code>](#Sharp)
+
+Take a "snapshot" of the Sharp instance, returning a new instance.
+Cloned instances inherit the input of their parent instance.
+This allows multiple output Streams and therefore multiple processing pipelines to share a single input Stream.
+
+
+**Example**  
+```js
+const pipeline = sharp().rotate();
+pipeline.clone().resize(800, 600).pipe(firstWritableStream);
+pipeline.clone().extract({ left: 20, top: 20, width: 100, height: 100 }).pipe(secondWritableStream);
+readableStream.pipe(pipeline);
+// firstWritableStream receives auto-rotated, resized readableStream
+// secondWritableStream receives auto-rotated, extracted region of readableStream
+```
+**Example**  
+```js
+// Create a pipeline that will download an image, resize it and format it to different files
+// Using Promises to know when the pipeline is complete
+const fs = require("fs");
+const got = require("got");
+const sharpStream = sharp({ failOn: 'none' });
+
+const promises = [];
+
+promises.push(
+  sharpStream
+    .clone()
+    .jpeg({ quality: 100 })
+    .toFile("originalFile.jpg")
+);
+
+promises.push(
+  sharpStream
+    .clone()
+    .resize({ width: 500 })
+    .jpeg({ quality: 80 })
+    .toFile("optimized-500.jpg")
+);
+
+promises.push(
+  sharpStream
+    .clone()
+    .resize({ width: 500 })
+    .webp({ quality: 80 })
+    .toFile("optimized-500.webp")
+);
+
+// https://github.com/sindresorhus/got/blob/main/documentation/3-streams.md
+got.stream("https://www.example.com/some-file.jpg").pipe(sharpStream);
+
+Promise.all(promises)
+  .then(res => { console.log("Done!", res); })
+  .catch(err => {
+    console.error("Error processing files, let's clean it up", err);
+    try {
+      fs.unlinkSync("originalFile.jpg");
+      fs.unlinkSync("optimized-500.jpg");
+      fs.unlinkSync("optimized-500.webp");
+    } catch (e) {}
+  });
+```

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

@@ -0,0 +1,139 @@
+---
+# 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
+- `xmpAsString`: String containing XMP data, if valid UTF-8.
+- `tifftagPhotoshop`: Buffer containing raw TIFFTAG_PHOTOSHOP data, if present
+- `formatMagick`: String containing format for images loaded via *magick
+- `comments`: Array of keyword/text pairs representing PNG text blocks, if present.
+
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [callback] | <code>function</code> | called with the arguments `(err, metadata)` |
+
+**Example**  
+```js
+const metadata = await sharp(input).metadata();
+```
+**Example**  
+```js
+const image = sharp(inputJpg);
+image
+  .metadata()
+  .then(function(metadata) {
+    return image
+      .resize(Math.round(metadata.width / 2))
+      .webp()
+      .toBuffer();
+  })
+  .then(function(data) {
+    // data contains a WebP image half the width and height of the original JPEG
+  });
+```
+**Example**  
+```js
+// Get dimensions taking EXIF Orientation into account.
+const { autoOrient } = await sharp(input).metadata();
+const { width, height } = autoOrient;
+```
+
+
+## stats
+> stats([callback]) ⇒ <code>Promise.&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,902 @@
+---
+# 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();
+```
+
+
+## keepXmp
+> keepXmp() ⇒ <code>Sharp</code>
+
+Keep XMP metadata from the input image in the output image.
+
+
+**Since**: 0.34.3  
+**Example**  
+```js
+const outputWithXmp = await sharp(inputWithXmp)
+  .keepXmp()
+  .toBuffer();
+```
+
+
+## withXmp
+> withXmp(xmp) ⇒ <code>Sharp</code>
+
+Set XMP metadata in the output image.
+
+Supported by PNG, JPEG, WebP, and TIFF output.
+
+
+**Throws**:
+
+- <code>Error</code> Invalid parameters
+
+**Since**: 0.34.3  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| xmp | <code>string</code> | String containing XMP metadata to be embedded in the output image. |
+
+**Example**  
+```js
+const xmpString = `
+  <?xml version="1.0"?>
+  <x:xmpmeta xmlns:x="adobe:ns:meta/">
+    <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+      <rdf:Description rdf:about="" xmlns:dc="http://purl.org/dc/elements/1.1/">
+        <dc:creator><rdf:Seq><rdf:li>John Doe</rdf:li></rdf:Seq></dc:creator>
+      </rdf:Description>
+    </rdf:RDF>
+  </x:xmpmeta>`;
+
+const data = await sharp(input)
+  .withXmp(xmpString)
+  .toBuffer();
+```
+
+
+## keepMetadata
+> keepMetadata() ⇒ <code>Sharp</code>
+
+Keep all metadata (EXIF, ICC, XMP, IPTC) from the input image in the output image.
+
+The default behaviour, when `keepMetadata` is not used, is to convert to the device-independent
+sRGB colour space and strip all metadata, including the removal of any ICC profile.
+
+
+**Since**: 0.33.0  
+**Example**  
+```js
+const outputWithMetadata = await sharp(inputWithMetadata)
+  .keepMetadata()
+  .toBuffer();
+```
+
+
+## withMetadata
+> withMetadata([options]) ⇒ <code>Sharp</code>
+
+Keep most metadata (EXIF, XMP, IPTC) from the input image in the output image.
+
+This will also convert to and add a web-friendly sRGB ICC profile if appropriate.
+
+Allows orientation and density to be set or updated.
+
+
+**Throws**:
+
+- <code>Error</code> Invalid parameters
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [options] | <code>Object</code> |  |
+| [options.orientation] | <code>number</code> | Used to update the EXIF `Orientation` tag, integer between 1 and 8. |
+| [options.density] | <code>number</code> | Number of pixels per inch (DPI). |
+
+**Example**  
+```js
+const outputSrgbWithMetadata = await sharp(inputRgbWithMetadata)
+  .withMetadata()
+  .toBuffer();
+```
+**Example**  
+```js
+// Set output metadata to 96 DPI
+const data = await sharp(input)
+  .withMetadata({ density: 96 })
+  .toBuffer();
+```
+
+
+## toFormat
+> toFormat(format, options) ⇒ <code>Sharp</code>
+
+Force output to a given format.
+
+
+**Throws**:
+
+- <code>Error</code> unsupported format or options
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| format | <code>string</code> \| <code>Object</code> | as a string or an Object with an 'id' attribute |
+| options | <code>Object</code> | output options |
+
+**Example**  
+```js
+// Convert any input to PNG output
+const data = await sharp(input)
+  .toFormat('png')
+  .toBuffer();
+```
+
+
+## jpeg
+> jpeg([options]) ⇒ <code>Sharp</code>
+
+Use these JPEG options for output image.
+
+
+**Throws**:
+
+- <code>Error</code> Invalid options
+
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [options] | <code>Object</code> |  | output options |
+| [options.quality] | <code>number</code> | <code>80</code> | quality, integer 1-100 |
+| [options.progressive] | <code>boolean</code> | <code>false</code> | use progressive (interlace) scan |
+| [options.chromaSubsampling] | <code>string</code> | <code>&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.keepDuplicateFrames] | <code>boolean</code> | <code>false</code> | keep duplicate frames in the output instead of combining them |
+| [options.loop] | <code>number</code> | <code>0</code> | number of animation iterations, use 0 for infinite animation |
+| [options.delay] | <code>number</code> \| <code>Array.&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.
+
+This feature is experimental on the Windows ARM64 platform
+and requires a CPU with ARM64v8.4 or later.
+
+
+**Throws**:
+
+- <code>Error</code> Invalid options
+
+**Since**: 0.27.0  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [options] | <code>Object</code> |  | output options |
+| [options.quality] | <code>number</code> | <code>50</code> | quality, integer 1-100 |
+| [options.lossless] | <code>boolean</code> | <code>false</code> | use lossless compression |
+| [options.effort] | <code>number</code> | <code>4</code> | CPU effort, between 0 (fastest) and 9 (slowest) |
+| [options.chromaSubsampling] | <code>string</code> | <code>&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,323 @@
+---
+# This file was auto-generated from JSDoc in lib/resize.js
+title: Resizing images
+---
+
+## resize
+> resize([width], [height], [options]) ⇒ <code>Sharp</code>
+
+Resize image to `width`, `height` or `width x height`.
+
+When both a `width` and `height` are provided, the possible methods by which the image should **fit** these are:
+- `cover`: (default) Preserving aspect ratio, attempt to ensure the image covers both provided dimensions by cropping/clipping to fit.
+- `contain`: Preserving aspect ratio, contain within both provided dimensions using "letterboxing" where necessary.
+- `fill`: Ignore the aspect ratio of the input and stretch to both provided dimensions.
+- `inside`: Preserving aspect ratio, resize the image to be as large as possible while ensuring its dimensions are less than or equal to both those specified.
+- `outside`: Preserving aspect ratio, resize the image to be as small as possible while ensuring its dimensions are greater than or equal to both those specified.
+
+Some of these values are based on the [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit) CSS property.
+
+<img alt="Examples of various values for the fit property when resizing" width="100%" style="aspect-ratio: 998/243" src="/api-resize-fit.svg">
+
+When using a **fit** of `cover` or `contain`, the default **position** is `centre`. Other options are:
+- `sharp.position`: `top`, `right top`, `right`, `right bottom`, `bottom`, `left bottom`, `left`, `left top`.
+- `sharp.gravity`: `north`, `northeast`, `east`, `southeast`, `south`, `southwest`, `west`, `northwest`, `center` or `centre`.
+- `sharp.strategy`: `cover` only, dynamically crop using either the `entropy` or `attention` strategy.
+
+Some of these values are based on the [object-position](https://developer.mozilla.org/en-US/docs/Web/CSS/object-position) CSS property.
+
+The strategy-based approach initially resizes so one dimension is at its target length
+then repeatedly ranks edge regions, discarding the edge with the lowest score based on the selected strategy.
+- `entropy`: focus on the region with the highest [Shannon entropy](https://en.wikipedia.org/wiki/Entropy_%28information_theory%29).
+- `attention`: focus on the region with the highest luminance frequency, colour saturation and presence of skin tones.
+
+Possible downsizing kernels are:
+- `nearest`: Use [nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation).
+- `linear`: Use a [triangle filter](https://en.wikipedia.org/wiki/Triangular_function).
+- `cubic`: Use a [Catmull-Rom spline](https://en.wikipedia.org/wiki/Centripetal_Catmull%E2%80%93Rom_spline).
+- `mitchell`: Use a [Mitchell-Netravali spline](https://www.cs.utexas.edu/~fussell/courses/cs384g-fall2013/lectures/mitchell/Mitchell.pdf).
+- `lanczos2`: Use a [Lanczos kernel](https://en.wikipedia.org/wiki/Lanczos_resampling#Lanczos_kernel) with `a=2`.
+- `lanczos3`: Use a Lanczos kernel with `a=3` (the default).
+- `mks2013`: Use a [Magic Kernel Sharp](https://johncostella.com/magic/mks.pdf) 2013 kernel, as adopted by Facebook.
+- `mks2021`: Use a Magic Kernel Sharp 2021 kernel, with more accurate (reduced) sharpening than the 2013 version.
+
+When upsampling, these kernels map to `nearest`, `linear` and `cubic` interpolators.
+Downsampling kernels without a matching upsampling interpolator map to `cubic`.
+
+Only one resize can occur per pipeline.
+Previous calls to `resize` in the same pipeline will be ignored.
+
+
+**Throws**:
+
+- <code>Error</code> Invalid parameters
+
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [width] | <code>number</code> |  | How many pixels wide the resultant image should be. Use `null` or `undefined` to auto-scale the width to match the height. |
+| [height] | <code>number</code> |  | How many pixels high the resultant image should be. Use `null` or `undefined` to auto-scale the height to match the width. |
+| [options] | <code>Object</code> |  |  |
+| [options.width] | <code>number</code> |  | An alternative means of specifying `width`. If both are present this takes priority. |
+| [options.height] | <code>number</code> |  | An alternative means of specifying `height`. If both are present this takes priority. |
+| [options.fit] | <code>String</code> | <code>&#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,232 @@
+---
+# 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.
+
+:::note
+Further [control over performance](/performance) is available.
+:::
+
+
+**Returns**: <code>number</code> - concurrency  
+
+| Param | Type |
+| --- | --- |
+| [concurrency] | <code>number</code> | 
+
+**Example**  
+```js
+const threads = sharp.concurrency(); // 4
+sharp.concurrency(2); // 2
+sharp.concurrency(0); // 4
+```
+
+
+## counters
+> counters() ⇒ <code>Object</code>
+
+Provides access to internal task counters.
+- queue is the number of tasks this module has queued waiting for _libuv_ to provide a worker thread from its pool.
+- process is the number of resize tasks currently being processed.
+
+
+**Example**  
+```js
+const counters = sharp.counters(); // { queue: 2, process: 4 }
+```
+
+
+## simd
+> simd([simd]) ⇒ <code>boolean</code>
+
+Get and set use of SIMD vector unit instructions.
+Requires libvips to have been compiled with highway support.
+
+Improves the performance of `resize`, `blur` and `sharpen` operations
+by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON.
+
+
+
+| Param | Type | Default |
+| --- | --- | --- |
+| [simd] | <code>boolean</code> | <code>true</code> | 
+
+**Example**  
+```js
+const simd = sharp.simd();
+// simd is `true` if the runtime use of highway is currently enabled
+```
+**Example**  
+```js
+const simd = sharp.simd(false);
+// prevent libvips from using highway at runtime
+```
+
+
+## block
+> block(options)
+
+Block libvips operations at runtime.
+
+This is in addition to the `VIPS_BLOCK_UNTRUSTED` environment variable,
+which when set will block all "untrusted" operations.
+
+
+**Since**: 0.32.4  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| options | <code>Object</code> |  |
+| options.operation | <code>Array.&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/changelog/_meta.yml

@@ -0,0 +1 @@
+sort: reverse-slug

docs/src/content/docs/changelog/v0.10.0.md

@@ -0,0 +1,22 @@
+---
+title: v0.10.0 - 23rd April 2015
+slug: changelog/v0.10.0
+---
+
+* Add support for Windows (x86).
+  [#19](https://github.com/lovell/sharp/issues/19)
+  [@DullReferenceException](https://github.com/DullReferenceException)
+  [@itsananderson](https://github.com/itsananderson)
+
+* Add support for Openslide input and DeepZoom output.
+  [#146](https://github.com/lovell/sharp/issues/146)
+  [@mvictoras](https://github.com/mvictoras)
+
+* Allow arbitrary aspect ratios when resizing images via new `ignoreAspectRatio` method.
+  [#192](https://github.com/lovell/sharp/issues/192)
+  [@skedastik](https://github.com/skedastik)
+
+* Enhance output image contrast by stretching its luminance to cover the full dynamic range via new `normalize` method.
+  [#194](https://github.com/lovell/sharp/issues/194)
+  [@bkw](https://github.com/bkw)
+  [@codingforce](https://github.com/codingforce)

docs/src/content/docs/changelog/v0.10.1.md

@@ -0,0 +1,12 @@
+---
+title: v0.10.1 - 1st June 2015
+slug: changelog/v0.10.1
+---
+
+* Allow embed of image with alpha transparency onto non-transparent background.
+  [#204](https://github.com/lovell/sharp/issues/204)
+  [@mikemliu](https://github.com/mikemliu)
+
+* Include C standard library for `atoi` as Xcode 6.3 appears to no longer do this.
+  [#228](https://github.com/lovell/sharp/issues/228)
+  [@doggan](https://github.com/doggan)

docs/src/content/docs/changelog/v0.11.0.md

@@ -0,0 +1,30 @@
+---
+title: v0.11.0 - 15th July 2015
+slug: changelog/v0.11.0
+---
+
+* Allow alpha transparency compositing via new `overlayWith` method.
+  [#97](https://github.com/lovell/sharp/issues/97)
+  [@gasi](https://github.com/gasi)
+
+* Expose raw ICC profile data as a Buffer when using `metadata`.
+  [#129](https://github.com/lovell/sharp/issues/129)
+  [@homerjam](https://github.com/homerjam)
+
+* Allow image header updates via a parameter passed to existing `withMetadata` method.
+  Provide initial support for EXIF `Orientation` tag,
+  which if present is now removed when using `rotate`, `flip` or `flop`.
+  [#189](https://github.com/lovell/sharp/issues/189)
+  [@h2non](https://github.com/h2non)
+
+* Tighten constructor parameter checks.
+  [#221](https://github.com/lovell/sharp/issues/221)
+  [@mikemorris](https://github.com/mikemorris)
+
+* Allow one input Stream to be shared with two or more output Streams via new `clone` method.
+  [#235](https://github.com/lovell/sharp/issues/235)
+  [@jaubourg](https://github.com/jaubourg)
+
+* Use `round` instead of `floor` when auto-scaling dimensions to avoid floating-point rounding errors.
+  [#238](https://github.com/lovell/sharp/issues/238)
+  [@richardadjogah](https://github.com/richardadjogah)

docs/src/content/docs/changelog/v0.11.1.md

@@ -0,0 +1,12 @@
+---
+title: v0.11.1 - 12th August 2015
+slug: changelog/v0.11.1
+---
+
+* Silence MSVC warning: "C4530: C++ exception handler used, but unwind semantics are not enabled".
+  [#244](https://github.com/lovell/sharp/pull/244)
+  [@TheThing](https://github.com/TheThing)
+
+* Suppress gamma correction for input image with alpha transparency.
+  [#249](https://github.com/lovell/sharp/issues/249)
+  [@compeak](https://github.com/compeak)

docs/src/content/docs/changelog/v0.11.2.md

@@ -0,0 +1,10 @@
+---
+title: v0.11.2 - 28th August 2015
+slug: changelog/v0.11.2
+---
+
+* Allow crop gravity to be provided as a String.
+  [#255](https://github.com/lovell/sharp/pull/255)
+  [@papandreou](https://github.com/papandreou)
+* Add support for io.js v3 and Node v4.
+  [#246](https://github.com/lovell/sharp/issues/246)

docs/src/content/docs/changelog/v0.11.3.md

@@ -0,0 +1,8 @@
+---
+title: v0.11.3 - 8th September 2015
+slug: changelog/v0.11.3
+---
+
+* Intrepret blurSigma, sharpenFlat, and sharpenJagged as double precision.
+  [#263](https://github.com/lovell/sharp/pull/263)
+  [@chrisriley](https://github.com/chrisriley)

docs/src/content/docs/changelog/v0.11.4.md

@@ -0,0 +1,16 @@
+---
+title: v0.11.4 - 5th November 2015
+slug: changelog/v0.11.4
+---
+
+* Add corners, e.g. `northeast`, to existing `gravity` option.
+  [#291](https://github.com/lovell/sharp/pull/291)
+  [@brandonaaron](https://github.com/brandonaaron)
+
+* Ensure correct auto-rotation for EXIF Orientation values 2 and 4.
+  [#288](https://github.com/lovell/sharp/pull/288)
+  [@brandonaaron](https://github.com/brandonaaron)
+
+* Make static linking possible via `--runtime_link` install option.
+  [#287](https://github.com/lovell/sharp/pull/287)
+  [@vlapo](https://github.com/vlapo)

docs/src/content/docs/changelog/v0.12.0.md

@@ -0,0 +1,38 @@
+---
+title: v0.12.0 - 23rd November 2015
+slug: changelog/v0.12.0
+---
+
+* Bundle pre-compiled libvips and its dependencies for 64-bit Linux and Windows.
+  [#42](https://github.com/lovell/sharp/issues/42)
+
+* Take advantage of libvips v8.1.0+ features.
+  [#152](https://github.com/lovell/sharp/issues/152)
+
+* Add support for 64-bit Windows. Drop support for 32-bit Windows.
+  [#224](https://github.com/lovell/sharp/issues/224)
+  [@sabrehagen](https://github.com/sabrehagen)
+
+* Switch default interpolator to bicubic.
+  [#289](https://github.com/lovell/sharp/issues/289)
+  [@mahnunchik](https://github.com/mahnunchik)
+
+* Pre-extract rotatation should not swap width/height.
+  [#296](https://github.com/lovell/sharp/issues/296)
+  [@asilvas](https://github.com/asilvas)
+
+* Ensure 16-bit+alpha input images are (un)premultiplied correctly.
+  [#301](https://github.com/lovell/sharp/issues/301)
+  [@izaakschroeder](https://github.com/izaakschroeder)
+
+* Add `threshold` operation.
+  [#303](https://github.com/lovell/sharp/pull/303)
+  [@dacarley](https://github.com/dacarley)
+
+* Add `negate` operation.
+  [#306](https://github.com/lovell/sharp/pull/306)
+  [@dacarley](https://github.com/dacarley)
+
+* Support `options` Object with existing `extract` operation.
+  [#309](https://github.com/lovell/sharp/pull/309)
+  [@papandreou](https://github.com/papandreou)

docs/src/content/docs/changelog/v0.12.1.md

@@ -0,0 +1,15 @@
+---
+title: v0.12.1 - 12th December 2015
+slug: changelog/v0.12.1
+---
+
+* Allow use of SIMD vector instructions (via liborc) to be toggled on/off.
+  [#172](https://github.com/lovell/sharp/issues/172)
+  [@bkw](https://github.com/bkw)
+  [@puzrin](https://github.com/puzrin)
+
+* Ensure embedded ICC profiles output with perceptual intent.
+  [#321](https://github.com/lovell/sharp/issues/321)
+  [@vlapo](https://github.com/vlapo)
+
+* Use the NPM-configured HTTPS proxy, if any, for binary downloads.

docs/src/content/docs/changelog/v0.12.2.md

@@ -0,0 +1,20 @@
+---
+title: v0.12.2 - 16th January 2016
+slug: changelog/v0.12.2
+---
+
+* Upgrade libvips to v8.2.0 for improved vips_shrink.
+
+* Add pre-compiled libvips for ARMv6+ CPUs.
+
+* Ensure 16-bit input images work with embed option.
+  [#325](https://github.com/lovell/sharp/issues/325)
+  [@janaz](https://github.com/janaz)
+
+* Allow compilation with gmake to provide FreeBSD support.
+  [#326](https://github.com/lovell/sharp/issues/326)
+  [@c0decafe](https://github.com/c0decafe)
+
+* Attempt to remove temporary file after installation.
+  [#331](https://github.com/lovell/sharp/issues/331)
+  [@dtoubelis](https://github.com/dtoubelis)

docs/src/content/docs/changelog/v0.13.0.md

@@ -0,0 +1,47 @@
+---
+title: v0.13.0 - 15th February 2016
+slug: changelog/v0.13.0
+---
+
+* Improve vector image support by allowing control of density/DPI.
+  Switch pre-built libs from Imagemagick to Graphicsmagick.
+  [#110](https://github.com/lovell/sharp/issues/110)
+  [@bradisbell](https://github.com/bradisbell)
+
+* Add support for raw, uncompressed pixel Buffer/Stream input.
+  [#220](https://github.com/lovell/sharp/issues/220)
+  [@mikemorris](https://github.com/mikemorris)
+
+* Switch from libvips' C to C++ bindings, requires upgrade to v8.2.2.
+  [#299](https://github.com/lovell/sharp/issues/299)
+
+* Control number of open files in libvips' cache; breaks existing `cache` behaviour.
+  [#315](https://github.com/lovell/sharp/issues/315)
+  [@impomezia](https://github.com/impomezia)
+
+* Ensure 16-bit input images can be normalised and embedded onto transparent backgrounds.
+  [#339](https://github.com/lovell/sharp/issues/339)
+  [#340](https://github.com/lovell/sharp/issues/340)
+  [@janaz](https://github.com/janaz)
+
+* Ensure selected format takes precedence over any unknown output filename extension.
+  [#344](https://github.com/lovell/sharp/issues/344)
+  [@ubaltaci](https://github.com/ubaltaci)
+
+* Add support for libvips' PBM, PGM, PPM and FITS image format loaders.
+  [#347](https://github.com/lovell/sharp/issues/347)
+  [@oaleynik](https://github.com/oaleynik)
+
+* Ensure default crop gravity is center/centre.
+  [#351](https://github.com/lovell/sharp/pull/351)
+  [@joelmukuthu](https://github.com/joelmukuthu)
+
+* Improve support for musl libc systems e.g. Alpine Linux.
+  [#354](https://github.com/lovell/sharp/issues/354)
+  [#359](https://github.com/lovell/sharp/pull/359)
+  [@download13](https://github.com/download13)
+  [@wjordan](https://github.com/wjordan)
+
+* Small optimisation when reducing by an integral factor to favour shrink over affine.
+
+* Add support for gamma correction of images with an alpha channel.

docs/src/content/docs/changelog/v0.13.1.md

@@ -0,0 +1,8 @@
+---
+title: v0.13.1 - 27th February 2016
+slug: changelog/v0.13.1
+---
+
+* Fix embedding onto transparent backgrounds; regression introduced in v0.13.0.
+  [#366](https://github.com/lovell/sharp/issues/366)
+  [@diegocsandrim](https://github.com/diegocsandrim)

docs/src/content/docs/changelog/v0.14.0.md

@@ -0,0 +1,39 @@
+---
+title: v0.14.0 - 2nd April 2016
+slug: changelog/v0.14.0
+---
+
+* Add ability to extend (pad) the edges of an image.
+  [#128](https://github.com/lovell/sharp/issues/128)
+  [@blowsie](https://github.com/blowsie)
+
+* Add support for Zoomify and Google tile layouts. Breaks existing tile API.
+  [#223](https://github.com/lovell/sharp/issues/223)
+  [@bdunnette](https://github.com/bdunnette)
+
+* Improvements to overlayWith: differing sizes/formats, gravity, buffer input.
+  [#239](https://github.com/lovell/sharp/issues/239)
+  [@chrisriley](https://github.com/chrisriley)
+
+* Add entropy-based crop strategy to remove least interesting edges.
+  [#295](https://github.com/lovell/sharp/issues/295)
+  [@rightaway](https://github.com/rightaway)
+
+* Expose density metadata; set density of images from vector input.
+  [#338](https://github.com/lovell/sharp/issues/338)
+  [@lookfirst](https://github.com/lookfirst)
+
+* Emit post-processing 'info' event for Stream output.
+  [#367](https://github.com/lovell/sharp/issues/367)
+  [@salzhrani](https://github.com/salzhrani)
+
+* Ensure output image EXIF Orientation values are within 1-8 range.
+  [#385](https://github.com/lovell/sharp/pull/385)
+  [@jtobinisaniceguy](https://github.com/jtobinisaniceguy)
+
+* Ensure ratios are not swapped when rotating 90/270 and ignoring aspect.
+  [#387](https://github.com/lovell/sharp/issues/387)
+  [@kleisauke](https://github.com/kleisauke)
+
+* Remove deprecated style of calling extract API. Breaks calls using positional arguments.
+  [#276](https://github.com/lovell/sharp/issues/276)

docs/src/content/docs/changelog/v0.14.1.md

@@ -0,0 +1,26 @@
+---
+title: v0.14.1 - 16th April 2016
+slug: changelog/v0.14.1
+---
+
+* Allow removal of limitation on input pixel count via limitInputPixels. Use with care.
+  [#250](https://github.com/lovell/sharp/issues/250)
+  [#316](https://github.com/lovell/sharp/pull/316)
+  [@anandthakker](https://github.com/anandthakker)
+  [@kentongray](https://github.com/kentongray)
+
+* Use final output image for metadata passed to callback.
+  [#399](https://github.com/lovell/sharp/pull/399)
+  [@salzhrani](https://github.com/salzhrani)
+
+* Add support for writing tiled images to a zip container.
+  [#402](https://github.com/lovell/sharp/pull/402)
+  [@felixbuenemann](https://github.com/felixbuenemann)
+
+* Allow use of embed with 1 and 2 channel images.
+  [#411](https://github.com/lovell/sharp/issues/411)
+  [@janaz](https://github.com/janaz)
+
+* Improve Electron compatibility by allowing node-gyp rebuilds without npm.
+  [#412](https://github.com/lovell/sharp/issues/412)
+  [@nouh](https://github.com/nouh)

docs/src/content/docs/changelog/v0.15.0.md

@@ -0,0 +1,20 @@
+---
+title: v0.15.0 - 21st May 2016
+slug: changelog/v0.15.0
+---
+
+* Use libvips' new Lanczos 3 kernel as default for image reduction.
+  Deprecate interpolateWith method, now provided as a resize option.
+  [#310](https://github.com/lovell/sharp/issues/310)
+  [@jcupitt](https://github.com/jcupitt)
+
+* Take advantage of libvips v8.3 features.
+  Add support for libvips' new GIF and SVG loaders.
+  Pre-built binaries now include giflib and librsvg, exclude *magick.
+  Use shrink-on-load for WebP input.
+  Break existing sharpen API to accept sigma and improve precision.
+  [#369](https://github.com/lovell/sharp/issues/369)
+
+* Remove unnecessary (un)premultiply operations when not resizing/compositing.
+  [#413](https://github.com/lovell/sharp/issues/413)
+  [@jardakotesovec](https://github.com/jardakotesovec)

docs/src/content/docs/changelog/v0.15.1.md

@@ -0,0 +1,68 @@
+---
+title: v0.15.1 - 12th July 2016
+slug: changelog/v0.15.1
+---
+
+* Concat Stream-based input in single operation for ~+3% perf and less GC.
+  [#429](https://github.com/lovell/sharp/issues/429)
+  [@papandreou](https://github.com/papandreou)
+
+* Add alpha channel, if required, before extend operation.
+  [#439](https://github.com/lovell/sharp/pull/439)
+  [@frulo](https://github.com/frulo)
+
+* Allow overlay image to be repeated across entire image via tile option.
+  [#443](https://github.com/lovell/sharp/pull/443)
+  [@lemnisk8](https://github.com/lemnisk8)
+
+* Add cutout option to overlayWith feature, applies only the alpha channel of the overlay image.
+  [#448](https://github.com/lovell/sharp/pull/448)
+  [@kleisauke](https://github.com/kleisauke)
+
+* Ensure scaling factors are calculated independently to prevent rounding errors.
+  [#452](https://github.com/lovell/sharp/issues/452)
+  [@puzrin](https://github.com/puzrin)
+
+* Add --sharp-cxx11 flag to compile with gcc's new C++11 ABI.
+  [#456](https://github.com/lovell/sharp/pull/456)
+  [@kapouer](https://github.com/kapouer)
+
+* Add top/left offset support to overlayWith operation.
+  [#473](https://github.com/lovell/sharp/pull/473)
+  [@rnanwani](https://github.com/rnanwani)
+
+* Add convolve operation for kernel-based convolution.
+  [#479](https://github.com/lovell/sharp/pull/479)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Add greyscale option to threshold operation for colourspace conversion control.
+  [#480](https://github.com/lovell/sharp/pull/480)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Ensure ICC profiles are licenced for distribution.
+  [#486](https://github.com/lovell/sharp/issues/486)
+  [@kapouer](https://github.com/kapouer)
+
+* Allow images with an alpha channel to work with LAB-colourspace based sharpen.
+  [#490](https://github.com/lovell/sharp/issues/490)
+  [@jwagner](https://github.com/jwagner)
+
+* Add trim operation to remove "boring" edges.
+  [#492](https://github.com/lovell/sharp/pull/492)
+  [@kleisauke](https://github.com/kleisauke)
+
+* Add bandbool feature for channel-wise boolean operations.
+  [#496](https://github.com/lovell/sharp/pull/496)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Add extractChannel operation to extract a channel from an image.
+  [#497](https://github.com/lovell/sharp/pull/497)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Add ability to read and write native libvips .v files.
+  [#500](https://github.com/lovell/sharp/pull/500)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Add boolean feature for bitwise image operations.
+  [#501](https://github.com/lovell/sharp/pull/501)
+  [@mhirsch](https://github.com/mhirsch)

docs/src/content/docs/changelog/v0.16.0.md

@@ -0,0 +1,42 @@
+---
+title: v0.16.0 - 18th August 2016
+slug: changelog/v0.16.0
+---
+
+* Add pre-compiled libvips for OS X, ARMv7 and ARMv8.
+  [#312](https://github.com/lovell/sharp/issues/312)
+
+* Ensure boolean, bandbool, extractChannel ops occur before sRGB conversion.
+  [#504](https://github.com/lovell/sharp/pull/504)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Recalculate factors after WebP shrink-on-load to avoid round-to-zero errors.
+  [#508](https://github.com/lovell/sharp/issues/508)
+  [@asilvas](https://github.com/asilvas)
+
+* Prevent boolean errors during extract operation.
+  [#511](https://github.com/lovell/sharp/pull/511)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Add joinChannel and toColourspace/toColorspace operations.
+  [#513](https://github.com/lovell/sharp/pull/513)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Add support for raw pixel data with boolean and withOverlay operations.
+  [#516](https://github.com/lovell/sharp/pull/516)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Prevent bandbool creating a single channel sRGB image.
+  [#519](https://github.com/lovell/sharp/pull/519)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Ensure ICC profiles are removed from PNG output unless withMetadata used.
+  [#521](https://github.com/lovell/sharp/issues/521)
+  [@ChrisPinewood](https://github.com/ChrisPinewood)
+
+* Add alpha channels, if missing, to overlayWith images.
+  [#540](https://github.com/lovell/sharp/pull/540)
+  [@cmtt](https://github.com/cmtt)
+
+* Remove deprecated interpolateWith method - use resize(w, h, { interpolator: ... })
+  [#310](https://github.com/lovell/sharp/issues/310)

docs/src/content/docs/changelog/v0.16.1.md

@@ -0,0 +1,21 @@
+---
+title: v0.16.1 - 13th October 2016
+slug: changelog/v0.16.1
+---
+
+* C++11 ABI version is now auto-detected, remove sharp-cxx11 installation flag.
+
+* Add experimental 'attention' crop strategy.
+  [#295](https://github.com/lovell/sharp/issues/295)
+
+* Include .node extension for Meteor's require() implementation.
+  [#537](https://github.com/lovell/sharp/issues/537)
+  [@isjackwild](https://github.com/isjackwild)
+
+* Ensure convolution kernel scale is clamped to a minimum value of 1.
+  [#561](https://github.com/lovell/sharp/issues/561)
+  [@abagshaw](https://github.com/abagshaw)
+
+* Correct calculation of y-axis placement when overlaying image at a fixed point.
+  [#566](https://github.com/lovell/sharp/issues/566)
+  [@Nateowami](https://github.com/Nateowami)

docs/src/content/docs/changelog/v0.16.2.md

@@ -0,0 +1,8 @@
+---
+title: v0.16.2 - 22nd October 2016
+slug: changelog/v0.16.2
+---
+
+* Restrict readelf usage to Linux only when detecting global libvips version.
+  [#602](https://github.com/lovell/sharp/issues/602)
+  [@caoko](https://github.com/caoko)

docs/src/content/docs/changelog/v0.17.0.md

@@ -0,0 +1,39 @@
+---
+title: v0.17.0 - 11th December 2016
+slug: changelog/v0.17.0
+---
+
+* Drop support for versions of Node prior to v4.
+
+* Deprecate the following output format "option" functions:
+    quality, progressive, compressionLevel, withoutAdaptiveFiltering,
+    withoutChromaSubsampling, trellisQuantisation, trellisQuantization,
+    overshootDeringing, optimiseScans and optimizeScans.
+  Access to these is now via output format functions, for example `quality(n)`
+    is now `jpeg({quality: n})` and/or `webp({quality: n})`.
+
+* Autoconvert GIF and SVG input to PNG output if no other format is specified.
+
+* Expose libvips' "centre" resize option to mimic \*magick's +0.5px convention.
+  [#568](https://github.com/lovell/sharp/issues/568)
+
+* Ensure support for embedded base64 PNG and JPEG images within an SVG.
+  [#601](https://github.com/lovell/sharp/issues/601)
+  [@dynamite-ready](https://github.com/dynamite-ready)
+
+* Ensure premultiply operation occurs before box filter shrink.
+  [#605](https://github.com/lovell/sharp/issues/605)
+  [@CmdrShepardsPie](https://github.com/CmdrShepardsPie)
+  [@teroparvinen](https://github.com/teroparvinen)
+
+* Add support for PNG and WebP tile-based output formats (in addition to JPEG).
+  [#622](https://github.com/lovell/sharp/pull/622)
+  [@ppaskaris](https://github.com/ppaskaris)
+
+* Allow use of extend with greyscale input.
+  [#623](https://github.com/lovell/sharp/pull/623)
+  [@ppaskaris](https://github.com/ppaskaris)
+
+* Allow non-RGB input to embed/extend onto background with an alpha channel.
+  [#646](https://github.com/lovell/sharp/issues/646)
+  [@DaGaMs](https://github.com/DaGaMs)

docs/src/content/docs/changelog/v0.17.1.md

@@ -0,0 +1,15 @@
+---
+title: v0.17.1 - 15th January 2017
+slug: changelog/v0.17.1
+---
+
+* Improve error messages for invalid parameters.
+  [@spikeon](https://github.com/spikeon)
+  [#644](https://github.com/lovell/sharp/pull/644)
+
+* Simplify expression for finding vips-cpp libdir.
+  [#656](https://github.com/lovell/sharp/pull/656)
+
+* Allow HTTPS-over-HTTP proxy when downloading pre-compiled dependencies.
+  [@wangzhiwei1888](https://github.com/wangzhiwei1888)
+  [#679](https://github.com/lovell/sharp/issues/679)

docs/src/content/docs/changelog/v0.17.2.md

@@ -0,0 +1,12 @@
+---
+title: v0.17.2 - 11th February 2017
+slug: changelog/v0.17.2
+---
+
+* Ensure Readable side of Stream can start flowing after Writable side has finished.
+  [#671](https://github.com/lovell/sharp/issues/671)
+  [@danhaller](https://github.com/danhaller)
+
+* Expose WebP alpha quality, lossless and near-lossless output options.
+  [#685](https://github.com/lovell/sharp/pull/685)
+  [@rnanwani](https://github.com/rnanwani)

docs/src/content/docs/changelog/v0.17.3.md

@@ -0,0 +1,20 @@
+---
+title: v0.17.3 - 1st April 2017
+slug: changelog/v0.17.3
+---
+
+* Allow toBuffer to optionally resolve a Promise with both info and data.
+  [#143](https://github.com/lovell/sharp/issues/143)
+  [@salzhrani](https://github.com/salzhrani)
+
+* Create blank image of given width, height, channels and background.
+  [#470](https://github.com/lovell/sharp/issues/470)
+  [@pjarts](https://github.com/pjarts)
+
+* Add support for the "nearest" kernel for image reductions.
+  [#732](https://github.com/lovell/sharp/pull/732)
+  [@alice0meta](https://github.com/alice0meta)
+
+* Add support for TIFF compression and predictor options.
+  [#738](https://github.com/lovell/sharp/pull/738)
+  [@kristojorg](https://github.com/kristojorg)

docs/src/content/docs/changelog/v0.18.0.md

@@ -0,0 +1,60 @@
+---
+title: v0.18.0 - 30th May 2017
+slug: changelog/v0.18.0
+---
+
+* Remove the previously-deprecated output format "option" functions:
+    quality, progressive, compressionLevel, withoutAdaptiveFiltering,
+    withoutChromaSubsampling, trellisQuantisation, trellisQuantization,
+    overshootDeringing, optimiseScans and optimizeScans.
+
+* Ensure maximum output dimensions are based on the format to be used.
+  [#176](https://github.com/lovell/sharp/issues/176)
+  [@stephanebachelier](https://github.com/stephanebachelier)
+
+* Avoid costly (un)premultiply when using overlayWith without alpha channel.
+  [#573](https://github.com/lovell/sharp/issues/573)
+  [@strarsis](https://github.com/strarsis)
+
+* Include pixel depth (e.g. "uchar") when reading metadata.
+  [#577](https://github.com/lovell/sharp/issues/577)
+  [@moedusa](https://github.com/moedusa)
+
+* Add support for Buffer and Stream-based TIFF output.
+  [#587](https://github.com/lovell/sharp/issues/587)
+  [@strarsis](https://github.com/strarsis)
+
+* Expose warnings from libvips via NODE_DEBUG=sharp environment variable.
+  [#607](https://github.com/lovell/sharp/issues/607)
+  [@puzrin](https://github.com/puzrin)
+
+* Switch to the libvips implementation of "attention" and "entropy" crop strategies.
+  [#727](https://github.com/lovell/sharp/issues/727)
+
+* Improve performance and accuracy of nearest neighbour integral upsampling.
+  [#752](https://github.com/lovell/sharp/issues/752)
+  [@MrIbby](https://github.com/MrIbby)
+
+* Constructor single argument API: allow plain object, reject null/undefined.
+  [#768](https://github.com/lovell/sharp/issues/768)
+  [@kub1x](https://github.com/kub1x)
+
+* Ensure ARM64 pre-built binaries use correct C++11 ABI version.
+  [#772](https://github.com/lovell/sharp/issues/772)
+  [@ajiratech2](https://github.com/ajiratech2)
+
+* Prevent aliasing by using dynamic values for shrink(-on-load).
+  [#781](https://github.com/lovell/sharp/issues/781)
+  [@kleisauke](https://github.com/kleisauke)
+
+* Expose libvips' "squash" parameter to enable 1-bit TIFF output.
+  [#783](https://github.com/lovell/sharp/pull/783)
+  [@YvesBos](https://github.com/YvesBos)
+
+* Add support for rotation using any multiple of +/-90 degrees.
+  [#791](https://github.com/lovell/sharp/pull/791)
+  [@ncoden](https://github.com/ncoden)
+
+* Add "jpg" alias to toFormat as shortened form of "jpeg".
+  [#814](https://github.com/lovell/sharp/pull/814)
+  [@jingsam](https://github.com/jingsam)

docs/src/content/docs/changelog/v0.18.1.md

@@ -0,0 +1,8 @@
+---
+title: v0.18.1 - 30th May 2017
+slug: changelog/v0.18.1
+---
+
+* Remove regression from #781 that could cause incorrect shrink calculation.
+  [#831](https://github.com/lovell/sharp/issues/831)
+  [@suprMax](https://github.com/suprMax)

docs/src/content/docs/changelog/v0.18.2.md

@@ -0,0 +1,19 @@
+---
+title: v0.18.2 - 1st July 2017
+slug: changelog/v0.18.2
+---
+
+* Expose libvips' xres and yres properties for TIFF output.
+  [#828](https://github.com/lovell/sharp/pull/828)
+  [@YvesBos](https://github.com/YvesBos)
+
+* Ensure flip and flop operations work with auto-rotate.
+  [#837](https://github.com/lovell/sharp/issues/837)
+  [@rexxars](https://github.com/rexxars)
+
+* Allow binary download URL override via SHARP_DIST_BASE_URL env variable.
+  [#841](https://github.com/lovell/sharp/issues/841)
+
+* Add support for Solus Linux.
+  [#857](https://github.com/lovell/sharp/pull/857)
+  [@ekremkaraca](https://github.com/ekremkaraca)

docs/src/content/docs/changelog/v0.18.3.md

@@ -0,0 +1,12 @@
+---
+title: v0.18.3 - 13th September 2017
+slug: changelog/v0.18.3
+---
+
+* Skip shrink-on-load when trimming.
+  [#888](https://github.com/lovell/sharp/pull/888)
+  [@kleisauke](https://github.com/kleisauke)
+
+* Migrate from got to simple-get for basic auth support.
+  [#945](https://github.com/lovell/sharp/pull/945)
+  [@pbomb](https://github.com/pbomb)

docs/src/content/docs/changelog/v0.18.4.md

@@ -0,0 +1,8 @@
+---
+title: v0.18.4 - 18th September 2017
+slug: changelog/v0.18.4
+---
+
+* Ensure input Buffer really is marked as Persistent, prevents mark-sweep GC.
+  [#950](https://github.com/lovell/sharp/issues/950)
+  [@lfdoherty](https://github.com/lfdoherty)

docs/src/content/docs/changelog/v0.19.0.md

@@ -0,0 +1,46 @@
+---
+title: v0.19.0 - 11th January 2018
+slug: changelog/v0.19.0
+---
+
+* Expose offset coordinates of strategy-based crop.
+  [#868](https://github.com/lovell/sharp/issues/868)
+  [@mirohristov-com](https://github.com/mirohristov-com)
+
+* PNG output now defaults to adaptiveFiltering=false, compressionLevel=9
+  [#872](https://github.com/lovell/sharp/issues/872)
+  [@wmertens](https://github.com/wmertens)
+
+* Add stats feature for pixel-derived image statistics.
+  [#915](https://github.com/lovell/sharp/pull/915)
+  [@rnanwani](https://github.com/rnanwani)
+
+* Add failOnError option to fail-fast on bad input image data.
+  [#976](https://github.com/lovell/sharp/pull/976)
+  [@mceachen](https://github.com/mceachen)
+
+* Resize: switch to libvips' implementation, make fastShrinkOnLoad optional, remove interpolator and centreSampling options.
+  [#977](https://github.com/lovell/sharp/pull/977)
+  [@jardakotesovec](https://github.com/jardakotesovec)
+
+* Attach finish event listener to a clone only for Stream-based input.
+  [#995](https://github.com/lovell/sharp/issues/995)
+  [@whmountains](https://github.com/whmountains)
+
+* Add tilecache before smartcrop to avoid over-computation of previous operations.
+  [#1028](https://github.com/lovell/sharp/issues/1028)
+  [@coffeebite](https://github.com/coffeebite)
+
+* Prevent toFile extension taking precedence over requested format.
+  [#1037](https://github.com/lovell/sharp/issues/1037)
+  [@tomgallagher](https://github.com/tomgallagher)
+
+* Add support for gravity option to existing embed feature.
+  [#1038](https://github.com/lovell/sharp/pull/1038)
+  [@AzureByte](https://github.com/AzureByte)
+
+* Expose IPTC and XMP metadata when available.
+  [#1079](https://github.com/lovell/sharp/pull/1079)
+  [@oaleynik](https://github.com/oaleynik)
+
+* TIFF output: switch default predictor from 'none' to 'horizontal' to match libvips' behaviour.

docs/src/content/docs/changelog/v0.19.1.md

@@ -0,0 +1,16 @@
+---
+title: v0.19.1 - 24th February 2018
+slug: changelog/v0.19.1
+---
+
+* Expose libvips' linear transform feature.
+  [#1024](https://github.com/lovell/sharp/pull/1024)
+  [@3epnm](https://github.com/3epnm)
+
+* Expose angle option for tile-based output.
+  [#1121](https://github.com/lovell/sharp/pull/1121)
+  [@BiancoA](https://github.com/BiancoA)
+
+* Prevent crop operation when image already at or below target dimensions.
+  [#1134](https://github.com/lovell/sharp/issues/1134)
+  [@pieh](https://github.com/pieh)

docs/src/content/docs/changelog/v0.20.0.md

@@ -0,0 +1,7 @@
+---
+title: v0.20.0 - 5th March 2018
+slug: changelog/v0.20.0
+---
+
+* Add support for prebuilt sharp binaries on common platforms.
+  [#186](https://github.com/lovell/sharp/issues/186)

docs/src/content/docs/changelog/v0.20.1.md

@@ -0,0 +1,15 @@
+---
+title: v0.20.1 - 17th March 2018
+slug: changelog/v0.20.1
+---
+
+* Improve installation experience when a globally-installed libvips below the minimum required version is found.
+  [#1148](https://github.com/lovell/sharp/issues/1148)
+
+* Prevent smartcrop error when cumulative rounding is below target size.
+  [#1154](https://github.com/lovell/sharp/issues/1154)
+  [@ralrom](https://github.com/ralrom)
+
+* Expose libvips' median filter operation.
+  [#1161](https://github.com/lovell/sharp/pull/1161)
+  [@BiancoA](https://github.com/BiancoA)

docs/src/content/docs/changelog/v0.20.2.md

@@ -0,0 +1,20 @@
+---
+title: v0.20.2 - 28th April 2018
+slug: changelog/v0.20.2
+---
+
+* Add tint operation to set image chroma.
+  [#825](https://github.com/lovell/sharp/pull/825)
+  [@rikh42](https://github.com/rikh42)
+
+* Add environment variable to ignore globally-installed libvips.
+  [#1165](https://github.com/lovell/sharp/pull/1165)
+  [@oncletom](https://github.com/oncletom)
+
+* Add support for page selection with multi-page input (GIF/TIFF).
+  [#1204](https://github.com/lovell/sharp/pull/1204)
+  [@woolite64](https://github.com/woolite64)
+
+* Add support for Group4 (CCITTFAX4) compression with TIFF output.
+  [#1208](https://github.com/lovell/sharp/pull/1208)
+  [@woolite64](https://github.com/woolite64)

docs/src/content/docs/changelog/v0.20.3.md

@@ -0,0 +1,8 @@
+---
+title: v0.20.3 - 29th May 2018
+slug: changelog/v0.20.3
+---
+
+* Fix tint operation by ensuring LAB interpretation and allowing negative values.
+  [#1235](https://github.com/lovell/sharp/issues/1235)
+  [@wezside](https://github.com/wezside)

docs/src/content/docs/changelog/v0.20.4.md

@@ -0,0 +1,12 @@
+---
+title: v0.20.4 - 20th June 2018
+slug: changelog/v0.20.4
+---
+
+* Prevent possible rounding error when using shrink-on-load and 90/270 degree rotation.
+  [#1241](https://github.com/lovell/sharp/issues/1241)
+  [@anahit42](https://github.com/anahit42)
+
+* Ensure extractChannel sets correct single-channel colour space interpretation.
+  [#1257](https://github.com/lovell/sharp/issues/1257)
+  [@jeremychone](https://github.com/jeremychone)

docs/src/content/docs/changelog/v0.20.5.md

@@ -0,0 +1,8 @@
+---
+title: v0.20.5 - 27th June 2018
+slug: changelog/v0.20.5
+---
+
+* Expose libjpeg optimize_coding flag.
+  [#1265](https://github.com/lovell/sharp/pull/1265)
+  [@tomlokhorst](https://github.com/tomlokhorst)

docs/src/content/docs/changelog/v0.20.6.md

@@ -0,0 +1,33 @@
+---
+title: v0.20.6 - 20th August 2018
+slug: changelog/v0.20.6
+---
+
+* Add removeAlpha operation to remove alpha channel, if any.
+  [#1248](https://github.com/lovell/sharp/issues/1248)
+
+* Expose mozjpeg quant_table flag.
+  [#1285](https://github.com/lovell/sharp/pull/1285)
+  [@rexxars](https://github.com/rexxars)
+
+* Allow full WebP alphaQuality range of 0-100.
+  [#1290](https://github.com/lovell/sharp/pull/1290)
+  [@sylvaindumont](https://github.com/sylvaindumont)
+
+* Cache libvips binaries to reduce re-install time.
+  [#1301](https://github.com/lovell/sharp/issues/1301)
+
+* Ensure vendor platform mismatch throws error at install time.
+  [#1303](https://github.com/lovell/sharp/issues/1303)
+
+* Improve install time error messages for FreeBSD users.
+  [#1310](https://github.com/lovell/sharp/issues/1310)
+
+* Ensure extractChannel works with 16-bit images.
+  [#1330](https://github.com/lovell/sharp/issues/1330)
+
+* Expose depth option for tile-based output.
+  [#1342](https://github.com/lovell/sharp/pull/1342)
+  [@alundavies](https://github.com/alundavies)
+
+* Add experimental entropy field to stats response.

docs/src/content/docs/changelog/v0.20.7.md

@@ -0,0 +1,7 @@
+---
+title: v0.20.7 - 21st August 2018
+slug: changelog/v0.20.7
+---
+
+* Use copy+unlink if rename operation fails during installation.
+  [#1345](https://github.com/lovell/sharp/issues/1345)

docs/src/content/docs/changelog/v0.20.8.md

@@ -0,0 +1,12 @@
+---
+title: v0.20.8 - 5th September 2018
+slug: changelog/v0.20.8
+---
+
+* Avoid race conditions when creating directories during installation.
+  [#1358](https://github.com/lovell/sharp/pull/1358)
+  [@ajhool](https://github.com/ajhool)
+
+* Accept floating point values for input density parameter.
+  [#1362](https://github.com/lovell/sharp/pull/1362)
+  [@aeirola](https://github.com/aeirola)

docs/src/content/docs/changelog/v0.21.0.md

@@ -0,0 +1,39 @@
+---
+title: v0.21.0 - 4th October 2018
+slug: changelog/v0.21.0
+---
+
+* Deprecate the following resize-related functions:
+    `crop`, `embed`, `ignoreAspectRatio`, `max`, `min` and `withoutEnlargement`.
+  Access to these is now via options passed to the `resize` function.
+  For example:
+    `embed('north')` is now `resize(width, height, { fit: 'contain', position: 'north' })`,
+    `crop('attention')` is now `resize(width, height, { fit: 'cover', position: 'attention' })`,
+    `max().withoutEnlargement()` is now `resize(width, height, { fit: 'inside', withoutEnlargement: true })`.
+  [#1135](https://github.com/lovell/sharp/issues/1135)
+
+* Deprecate the `background` function.
+    Per-operation `background` options added to `resize`, `extend` and `flatten` operations.
+  [#1392](https://github.com/lovell/sharp/issues/1392)
+
+* Add `size` to `metadata` response (Stream and Buffer input only).
+  [#695](https://github.com/lovell/sharp/issues/695)
+
+* Switch from custom trim operation to `vips_find_trim`.
+  [#914](https://github.com/lovell/sharp/issues/914)
+
+* Add `chromaSubsampling` and `isProgressive` properties to `metadata` response.
+  [#1186](https://github.com/lovell/sharp/issues/1186)
+
+* Drop Node 4 support.
+  [#1212](https://github.com/lovell/sharp/issues/1212)
+
+* Enable SIMD convolution by default.
+  [#1213](https://github.com/lovell/sharp/issues/1213)
+
+* Add experimental prebuilt binaries for musl-based Linux.
+  [#1379](https://github.com/lovell/sharp/issues/1379)
+
+* Add support for arbitrary rotation angle via vips_rotate.
+  [#1385](https://github.com/lovell/sharp/pull/1385)
+  [@freezy](https://github.com/freezy)

docs/src/content/docs/changelog/v0.21.1.md

@@ -0,0 +1,31 @@
+---
+title: v0.21.1 - 7th December 2018
+slug: changelog/v0.21.1
+---
+
+* Install: support `sharp_dist_base_url` npm config, like existing `SHARP_DIST_BASE_URL`.
+  [#1422](https://github.com/lovell/sharp/pull/1422)
+  [@SethWen](https://github.com/SethWen)
+
+* Ensure `channel` metadata is correct for raw, greyscale output.
+  [#1425](https://github.com/lovell/sharp/issues/1425)
+
+* Add support for the "mitchell" kernel for image reductions.
+  [#1438](https://github.com/lovell/sharp/pull/1438)
+  [@Daiz](https://github.com/Daiz)
+
+* Allow separate parameters for gamma encoding and decoding.
+  [#1439](https://github.com/lovell/sharp/pull/1439)
+  [@Daiz](https://github.com/Daiz)
+
+* Build prototype with `Object.assign` to allow minification.
+  [#1475](https://github.com/lovell/sharp/pull/1475)
+  [@jaubourg](https://github.com/jaubourg)
+
+* Expose libvips' recombination matrix operation.
+  [#1477](https://github.com/lovell/sharp/pull/1477)
+  [@fromkeith](https://github.com/fromkeith)
+
+* Expose libvips' pyramid/tile options for TIFF output.
+  [#1483](https://github.com/lovell/sharp/pull/1483)
+  [@mbklein](https://github.com/mbklein)