Skip to content

Commit cd337e4

Browse files
committed
Docs: extractChannel output colourspace is b-w or grey16
1 parent 51d1a49 commit cd337e4

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

docs/src/content/docs/api-channel.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ const rgba = await sharp(rgb)
6161
6262
Extract a single channel from a multi-channel image.
6363

64+
The output colourspace will be either `b-w` (8-bit) or `grey16` (16-bit).
65+
6466

6567
**Throws**:
6668

lib/channel.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ function ensureAlpha (alpha) {
7474
/**
7575
* Extract a single channel from a multi-channel image.
7676
*
77+
* The output colourspace will be either `b-w` (8-bit) or `grey16` (16-bit).
78+
*
7779
* @example
7880
* // green.jpg is a greyscale image containing the green channel of the input
7981
* await sharp(input)

0 commit comments

Comments
 (0)