Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-12-19 15:25:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs: changelog and credit for #3556

Browse Source
This commit is contained in:
Lovell Fuller
2023-02-18 12:50:58 +00:00
parent 6f0e6f2e65
commit 863e37455a
6 changed files with 36 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
lib/index.d.ts vendored
View File

@@ -755,7 +755,8 @@ declare namespace sharp {
resize(options: ResizeOptions): Sharp;
/**
* Extends/pads the edges of the image with either the provided background colour or pixels derived from the image.
* 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.
* @param extend single pixel count to add to all edges or an Object with per-edge counts
* @throws {Error} Invalid parameters

15
lib/resize.js
View File

@@ -334,7 +334,8 @@ function resize (width, height, options) {
}
/**
* Extends/pads the edges of the image with the provided background colour.
* Extend / pad / extrude one or more edges of the image with either
* the provided background colour or pixels derived from the image.
* This operation will always occur after resizing and extraction, if any.
*
* @example
@@ -360,11 +361,21 @@ function resize (width, height, options) {
* })
* ...
*
* @example
* // Extrude image by 8 pixels to the right, mirroring existing right hand edge
* sharp(input)
* .extend({
* right: 8,
* background: 'mirror'
* })
* ...
*
* @param {(number|Object)} extend - single pixel count to add to all edges or an Object with per-edge counts
* @param {number} [extend.top=0]
* @param {number} [extend.left=0]
* @param {number} [extend.bottom=0]
* @param {number} [extend.right=0]
* @param {String} [extend.extendWith='background'] - populate new pixels using this method, one of: background, copy, repeat, mirror.
* @param {String|Object} [extend.background={r: 0, g: 0, b: 0, alpha: 1}] - background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to black without transparency.
* @returns {Sharp}
* @throws {Error} Invalid parameters
@@ -409,7 +420,7 @@ function extend (extend) {
if (is.string(extendWith[extend.extendWith])) {
this.options.extendWith = extendWith[extend.extendWith];
} else {
throw is.invalidParameterError('extendWith', 'valid value', extend.extendWith);
throw is.invalidParameterError('extendWith', 'one of: background, copy, repeat, mirror', extend.extendWith);
}
}
} else {