mirror of
https://github.com/lovell/sharp.git
synced 2025-07-09 18:40:16 +02:00
87 lines
3.5 KiB
Markdown
87 lines
3.5 KiB
Markdown
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
|
|
|
|
# clone
|
|
|
|
Take a "snapshot" of the Sharp instance, returning a new instance.
|
|
Cloned instances inherit the input of their parent instance.
|
|
This allows multiple output Streams and therefore multiple processing pipelines to share a single input Stream.
|
|
|
|
**Examples**
|
|
|
|
```javascript
|
|
const pipeline = sharp().rotate();
|
|
pipeline.clone().resize(800, 600).pipe(firstWritableStream);
|
|
pipeline.clone().extract({ left: 20, top: 20, width: 100, height: 100 }).pipe(secondWritableStream);
|
|
readableStream.pipe(pipeline);
|
|
// firstWritableStream receives auto-rotated, resized readableStream
|
|
// secondWritableStream receives auto-rotated, extracted region of readableStream
|
|
```
|
|
|
|
Returns **Sharp**
|
|
|
|
# metadata
|
|
|
|
Fast access to image metadata without decoding any compressed image data.
|
|
A Promises/A+ promise is returned when `callback` is not provided.
|
|
|
|
- `format`: Name of decoder used to decompress image data e.g. `jpeg`, `png`, `webp`, `gif`, `svg`
|
|
- `width`: Number of pixels wide
|
|
- `height`: Number of pixels high
|
|
- `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568)
|
|
- `channels`: Number of bands e.g. `3` for sRGB, `4` for CMYK
|
|
- `density`: Number of pixels per inch (DPI), if present
|
|
- `hasProfile`: Boolean indicating the presence of an embedded ICC profile
|
|
- `hasAlpha`: Boolean indicating the presence of an alpha transparency channel
|
|
- `orientation`: Number value of the EXIF Orientation header, if present
|
|
- `exif`: Buffer containing raw EXIF data, if present
|
|
- `icc`: Buffer containing raw [ICC](https://www.npmjs.com/package/icc) profile data, if present
|
|
|
|
**Parameters**
|
|
|
|
- `callback` **\[[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** called with the arguments `(err, metadata)`
|
|
|
|
**Examples**
|
|
|
|
```javascript
|
|
const image = sharp(inputJpg);
|
|
image
|
|
.metadata()
|
|
.then(function(metadata) {
|
|
return image
|
|
.resize(Math.round(metadata.width / 2))
|
|
.webp()
|
|
.toBuffer();
|
|
})
|
|
.then(function(data) {
|
|
// data contains a WebP image half the width and height of the original JPEG
|
|
});
|
|
```
|
|
|
|
Returns **([Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)> | Sharp)**
|
|
|
|
# limitInputPixels
|
|
|
|
Do not process input images where the number of pixels (width _ height) exceeds this limit.
|
|
Assumes image dimensions contained in the input metadata can be trusted.
|
|
The default limit is 268402689 (0x3FFF _ 0x3FFF) pixels.
|
|
|
|
**Parameters**
|
|
|
|
- `limit` **([Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean))** an integral Number of pixels, zero or false to remove limit, true to use default limit.
|
|
|
|
|
|
- Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid limit
|
|
|
|
Returns **Sharp**
|
|
|
|
# sequentialRead
|
|
|
|
An advanced setting that switches the libvips access method to `VIPS_ACCESS_SEQUENTIAL`.
|
|
This will reduce memory usage and can improve performance on some systems.
|
|
|
|
**Parameters**
|
|
|
|
- `sequentialRead` **\[[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** (optional, default `true`)
|
|
|
|
Returns **Sharp**
|