Skip to content

Commit

Permalink
Bump devDeps, requires doc refresh
Browse files Browse the repository at this point in the history
  • Loading branch information
lovell committed Aug 20, 2022
1 parent cc9f91f commit b9261c2
Show file tree
Hide file tree
Showing 11 changed files with 89 additions and 89 deletions.
10 changes: 5 additions & 5 deletions docs/api-channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ sharp('rgba.png')
});
```

Returns **Sharp**
Returns **Sharp** 

## ensureAlpha

Expand Down Expand Up @@ -47,7 +47,7 @@ const rgba = await sharp(rgb)

* Throws **[Error][3]** Invalid alpha transparency level

Returns **Sharp**
Returns **Sharp** 

**Meta**

Expand Down Expand Up @@ -80,7 +80,7 @@ const [red1, red2, ...] = await sharp(input)

* Throws **[Error][3]** Invalid channel

Returns **Sharp**
Returns **Sharp** 

## joinChannel

Expand All @@ -104,7 +104,7 @@ For raw pixel input, the `options` object should contain a `raw` attribute, whic

* Throws **[Error][3]** Invalid parameters

Returns **Sharp**
Returns **Sharp** 

## bandbool

Expand All @@ -128,7 +128,7 @@ sharp('3-channel-rgb-input.png')

* Throws **[Error][3]** Invalid parameters

Returns **Sharp**
Returns **Sharp** 

[1]: /api-operation#flatten

Expand Down
14 changes: 7 additions & 7 deletions docs/api-colour.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const output = await sharp(input)

* Throws **[Error][4]** Invalid parameter

Returns **Sharp**
Returns **Sharp** 

## greyscale

Expand All @@ -40,7 +40,7 @@ An alpha channel may be present, and will be unchanged by the operation.
const output = await sharp(input).greyscale().toBuffer();
```

Returns **Sharp**
Returns **Sharp** 

## grayscale

Expand All @@ -50,7 +50,7 @@ Alternative spelling of `greyscale`.

* `grayscale` **[Boolean][5]** (optional, default `true`)

Returns **Sharp**
Returns **Sharp** 

## pipelineColourspace

Expand All @@ -77,7 +77,7 @@ await sharp(input)

* Throws **[Error][4]** Invalid parameters

Returns **Sharp**
Returns **Sharp** 

**Meta**

Expand All @@ -95,7 +95,7 @@ Alternative spelling of `pipelineColourspace`.

* Throws **[Error][4]** Invalid parameters

Returns **Sharp**
Returns **Sharp** 

## toColourspace

Expand All @@ -117,7 +117,7 @@ await sharp(input)

* Throws **[Error][4]** Invalid parameters

Returns **Sharp**
Returns **Sharp** 

## toColorspace

Expand All @@ -131,7 +131,7 @@ Alternative spelling of `toColourspace`.

* Throws **[Error][4]** Invalid parameters

Returns **Sharp**
Returns **Sharp** 

[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

Expand Down
12 changes: 6 additions & 6 deletions docs/api-composite.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ and [https://www.cairographics.org/operators/][2]

* `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.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[].input.text` **[Object][4]?** describes a new text image to be created.
Expand All @@ -50,9 +50,9 @@ and [https://www.cairographics.org/operators/][2]
* `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[].raw.width` **[Number][7]?** 
* `images[].raw.height` **[Number][7]?** 
* `images[].raw.channels` **[Number][7]?** 
* `images[].animated` **[boolean][9]** Set to `true` to read all frames/pages of an animated image. (optional, default `false`)
* `images[].failOn` **[string][6]** @see [constructor parameters][10] (optional, default `'warning'`)
* `images[].limitInputPixels` **([number][7] | [boolean][9])** @see [constructor parameters][10] (optional, default `268402689`)
Expand Down Expand Up @@ -95,7 +95,7 @@ sharp('input.png')

* Throws **[Error][11]** Invalid parameters

Returns **Sharp**
Returns **Sharp** 

**Meta**

Expand Down
4 changes: 2 additions & 2 deletions docs/api-constructor.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ await sharp({

* Throws **[Error][17]** Invalid parameters

Returns **[Sharp][18]**
Returns **[Sharp][18]** 

## clone

Expand Down Expand Up @@ -230,7 +230,7 @@ Promise.all(promises)
});
```

Returns **[Sharp][18]**
Returns **[Sharp][18]** 

[1]: http://nodejs.org/api/stream.html#stream_class_stream_duplex

Expand Down
6 changes: 3 additions & 3 deletions docs/api-input.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ A `Promise` is returned when `callback` is not provided.
* `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
* `tifftagPhotoshop`: Buffer containing raw TIFFTAG\_PHOTOSHOP data, if present

### Parameters

Expand Down Expand Up @@ -75,7 +75,7 @@ function getNormalSize({ width, height, orientation }) {
}
```

Returns **([Promise][5]<[Object][6]> | Sharp)**
Returns **([Promise][5]<[Object][6]> | Sharp)**&#x20;

## stats

Expand Down Expand Up @@ -129,7 +129,7 @@ const part = await image.extract(region).toBuffer();
const stats = await sharp(part).stats();
```

Returns **[Promise][5]<[Object][6]>**
Returns **[Promise][5]<[Object][6]>**&#x20;

[1]: https://www.libvips.org/API/current/VipsImage.html#VipsInterpretation

Expand Down

0 comments on commit b9261c2

Please sign in to comment.