UNPKG

sharp

Version:

High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP and TIFF images

github.com/lovell/sharp

lovell/sharp

80 lines (42 loc) • 2.24 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<!-- Generated by documentation.js. Update this documentation by updating the source code. --> ## tint Tint the image using the provided chroma while preserving the image luminance. An alpha channel may be present and will be unchanged by the operation. ### Parameters - `rgb` **([String][1] \| [Object][2])** parsed by the [color][3] module to extract chroma values. - Throws **[Error][4]** Invalid parameter Returns **Sharp** ## greyscale Convert to 8-bit greyscale; 256 shades of grey. This is a linear operation. If the input image is in a non-linear colour space such as sRGB, use `gamma()` with `greyscale()` for the best results. By default the output image will be web-friendly sRGB and contain three (identical) color channels. This may be overridden by other sharp operations such as `toColourspace('b-w')`, which will produce an output image containing one color channel. An alpha channel may be present, and will be unchanged by the operation. ### Parameters - `greyscale` **[Boolean][5]** (optional, default `true`) Returns **Sharp** ## grayscale Alternative spelling of `greyscale`. ### Parameters - `grayscale` **[Boolean][5]** (optional, default `true`) Returns **Sharp** ## toColourspace Set the output colourspace. By default output image will be web-friendly sRGB, with additional channels interpreted as alpha channels. ### Parameters - `colourspace` **[String][1]?** output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...][6] - Throws **[Error][4]** Invalid parameters Returns **Sharp** ## toColorspace Alternative spelling of `toColourspace`. ### Parameters - `colorspace` **[String][1]?** output colorspace. - Throws **[Error][4]** Invalid parameters Returns **Sharp** [1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String [2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object [3]: https://www.npmjs.org/package/color [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean [6]: https://github.com/libvips/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568