Fix edgeHandling types

[domdomegg]

What's Changing and Why

Fixes the edgeHandling type definitions and documentation around convolution.

Why is number correct?

• Only used in convolution to call getPixelIndex https://github.com/oliver-moran/jimp/blob/53ff9d1266207f7f674233f465ec358274510511/packages/plugin-color/src/index.js#L400
• getPixelIndex only compares this against constants https://github.com/oliver-moran/jimp/blob/53ff9d1266207f7f674233f465ec358274510511/packages/core/src/index.js#L699-L722
• These constants are numbers https://github.com/oliver-moran/jimp/blob/53ff9d1266207f7f674233f465ec358274510511/packages/core/src/constants.js#L26-L29

A future improvement may be to make all functions that expect constants to be typed to only accept those constants. But I think that's beyond the scope of this PR for now.

I have also updated the documentation that preivously had a comment 'make me better' to give a more practical example of how to call the convolution method.

Tasks

• Add tests: Not done because just updating docs and types (and there are no type tests as far as I can see)
• Update Documentation
• Update jimp.d.ts
• Add SemVer Label: Happy to add in PR, but assumed library maintainers would want to do that centrally to avoid conflicts?

📦 Published PR as canary version: 0.16.2-canary.1080.1288.0

✨ Test out this PR locally via:

npm install @jimp/cli@0.16.2-canary.1080.1288.0
npm install @jimp/core@0.16.2-canary.1080.1288.0
npm install @jimp/custom@0.16.2-canary.1080.1288.0
npm install jimp@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-blit@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-blur@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-circle@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-color@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-contain@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-cover@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-crop@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-displace@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-dither@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-fisheye@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-flip@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-gaussian@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-invert@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-mask@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-normalize@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-print@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-resize@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-rotate@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-scale@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-shadow@0.16.2-canary.1080.1288.0
npm install @jimp/plugin-threshold@0.16.2-canary.1080.1288.0
npm install @jimp/plugins@0.16.2-canary.1080.1288.0
npm install @jimp/test-utils@0.16.2-canary.1080.1288.0
npm install @jimp/bmp@0.16.2-canary.1080.1288.0
npm install @jimp/gif@0.16.2-canary.1080.1288.0
npm install @jimp/jpeg@0.16.2-canary.1080.1288.0
npm install @jimp/png@0.16.2-canary.1080.1288.0
npm install @jimp/tiff@0.16.2-canary.1080.1288.0
npm install @jimp/types@0.16.2-canary.1080.1288.0
npm install @jimp/utils@0.16.2-canary.1080.1288.0
# or 
yarn add @jimp/cli@0.16.2-canary.1080.1288.0
yarn add @jimp/core@0.16.2-canary.1080.1288.0
yarn add @jimp/custom@0.16.2-canary.1080.1288.0
yarn add jimp@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-blit@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-blur@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-circle@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-color@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-contain@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-cover@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-crop@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-displace@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-dither@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-fisheye@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-flip@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-gaussian@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-invert@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-mask@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-normalize@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-print@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-resize@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-rotate@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-scale@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-shadow@0.16.2-canary.1080.1288.0
yarn add @jimp/plugin-threshold@0.16.2-canary.1080.1288.0
yarn add @jimp/plugins@0.16.2-canary.1080.1288.0
yarn add @jimp/test-utils@0.16.2-canary.1080.1288.0
yarn add @jimp/bmp@0.16.2-canary.1080.1288.0
yarn add @jimp/gif@0.16.2-canary.1080.1288.0
yarn add @jimp/jpeg@0.16.2-canary.1080.1288.0
yarn add @jimp/png@0.16.2-canary.1080.1288.0
yarn add @jimp/tiff@0.16.2-canary.1080.1288.0
yarn add @jimp/types@0.16.2-canary.1080.1288.0
yarn add @jimp/utils@0.16.2-canary.1080.1288.0

[domdomegg]

Thanks for the review and merge @hipstersmoothie 🙌

[hipstersmoothie]

🚀 PR was released in v0.16.13 🚀