Merge branch 'main' into feature/unflatten

.github/CONTRIBUTING.md

@@ -33,6 +33,7 @@ To test C++ changes, you can compile the module using `npm install --build-from-
 
 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)

README.md

@@ -102,7 +102,7 @@ covers reporting bugs, requesting features and submitting code changes.
 
 ## 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.

binding.gyp

@@ -179,7 +179,7 @@
     ],
     'xcode_settings': {
       'CLANG_CXX_LANGUAGE_STANDARD': 'c++11',
-      'MACOSX_DEPLOYMENT_TARGET': '10.9',
+      'MACOSX_DEPLOYMENT_TARGET': '10.13',
       'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
       'GCC_ENABLE_CPP_RTTI': 'YES',
       'OTHER_CPLUSPLUSFLAGS': [

docs/README.md

@@ -74,7 +74,7 @@ covers reporting bugs, requesting features and submitting code changes.
 
 ### 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.

docs/api-channel.md

@@ -1,145 +1,126 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
 ## removeAlpha
-
 Remove alpha channel, 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) {
     // rgb.png is a 3 channel image without an alpha channel
   });
 ```
 
-Returns **Sharp**&#x20;
 
 ## ensureAlpha
-
 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**:
+
+- <code>Error</code> Invalid alpha transparency level
 
-### Examples
+**Since**: 0.21.2  
 
-```javascript
+| 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**&#x20;
-
-**Meta**
-
-*   **since**: 0.21.2
 
 ## extractChannel
-
 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**:
+
+- <code>Error</code> Invalid channel
+
 
-### Examples
+| Param | Type | Description |
+| --- | --- | --- |
+| channel | <code>number</code> \| <code>string</code> | zero-indexed channel/band number to extract, or `red`, `green`, `blue` or `alpha`. |
 
-```javascript
+**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)
   .raw()
   .toBuffer();
 ```
 
-*   Throws **[Error][3]** Invalid channel
-
-Returns **Sharp**&#x20;
 
 ## joinChannel
-
 Join one or more channels to the image.
 The meaning of the added channels depends on the output colourspace, set with `toColourspace()`.
 By default the output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.
 Channel ordering follows vips convention:
-
-*   sRGB: 0: Red, 1: Green, 2: Blue, 3: Alpha.
-*   CMYK: 0: Magenta, 1: Cyan, 2: Yellow, 3: Black, 4: Alpha.
+- 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
 
-*   Throws **[Error][3]** Invalid parameters
 
-Returns **Sharp**&#x20;
+| Param | Type | Description |
+| --- | --- | --- |
+| images | <code>Array.&lt;(string\|Buffer)&gt;</code> \| <code>string</code> \| <code>Buffer</code> | one or more images (file paths, Buffers). |
+| options | <code>Object</code> | image options, see `sharp()` constructor. |
+
 
-## bandbool
 
+## bandbool
 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**:
+
+- <code>Error</code> Invalid parameters
 
-### Examples
 
-```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) {
     // The output will be a single channel image where each pixel `P = R & G & B`.
     // If `I(1,1) = [247, 170, 14] = [0b11110111, 0b10101010, 0b00001111]`
     // then `O(1,1) = 0b11110111 & 0b10101010 & 0b00001111 = 0b00000010 = 2`.
   });
-```
-
-*   Throws **[Error][3]** Invalid parameters
-
-Returns **Sharp**&#x20;
-
-[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
+```