Docs refresh

This commit is contained in:
Lovell Fuller 2022-01-18 10:29:18 +00:00
parent 638d540371
commit 161d127bf3
3 changed files with 32 additions and 3 deletions

View File

@ -159,14 +159,28 @@ Returns **Sharp**
## blur
Blur the image.
When used without parameters, performs a fast, mild blur of the output 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

File diff suppressed because one or more lines are too long

View File

@ -20,14 +20,19 @@ module.exports = [
'callback',
'can',
'containing',
'contains',
'current',
'date',
'default',
'does',
'each',
'either',
'ensure',
'entirely',
'etc',
'every',
'except',
'following',
'for',
'from',
'get',
@ -37,10 +42,13 @@ module.exports = [
'have',
'how',
'image',
'implies',
'involve',
'its',
'last',
'least',
'lots',
'make',
'may',
'more',
'most',
@ -56,6 +64,7 @@ module.exports = [
'over',
'perform',
'performs',
'produce',
'provide',
'provided',
'ready',
@ -67,12 +76,15 @@ module.exports = [
'sets',
'should',
'since',
'site',
'specified',
'spelling',
'such',
'support',
'supported',
'sure',
'take',
'task',
'than',
'that',
'the',
@ -84,12 +96,15 @@ module.exports = [
'this',
'under',
'unless',
'unmaintained',
'unsuitable',
'until',
'use',
'used',
'using',
'value',
'values',
'were',
'when',
'which',
'while',