构造函数

Sharp

Sharp

发出: Sharp#event:info, Sharp#event:warning

new

new Sharp([input], [options])

构造函数工厂，用于创建 sharp 的实例，随后可以链式调用其他方法。

可以从此对象流出 JPEG、PNG、WebP、GIF、AVIF 或 TIFF 格式的图像数据。当使用基于流的输出时，可以从 info 事件中获得派生属性。

在处理过程中遇到的非关键问题将作为 warning 事件发出。

实现了 stream.Duplex 类。

当加载多个页面/帧的动画图像时，这些将组合成一个垂直堆叠的“厕纸卷”图像，其整体高度为 pageHeight 乘以 pages 的数量。

抛出:

• Error 无效参数

参数	类型	默认	描述
[input]	Buffer | ArrayBuffer | Uint8Array | Uint8ClampedArray | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Float32Array | Float64Array | string | Array		如果存在，可以是包含 JPEG、PNG、WebP、AVIF、GIF、SVG 或 TIFF 图像数据的 Buffer / ArrayBuffer / Uint8Array / Uint8ClampedArray，或包含原始像素图像数据的 TypedArray，或包含 JPEG、PNG、WebP、AVIF、GIF、SVG 或 TIFF 图像文件系统路径的字符串。可以提供输入数组，输入将被合并。当未提供输入时，可以将 JPEG、PNG、WebP、AVIF、GIF、SVG、TIFF 或原始像素图像数据以流式方式输入对象。
[options]	Object		如果存在，是包含可选属性的对象。
[options.failOn]	string	“‘warning‘“	何时中止对无效像素数据的处理，顺序由灵敏度从低到高：‘none’、‘truncated’、‘error’、‘warning’。更高级别包含较低级别。无效元数据总是中止。
[options.limitInputPixels]	number | boolean	268402689	不处理像素数（宽 x 高）超过此限制的输入图像。假定可信赖输入元数据中的图像尺寸。整数像素数，0或false为移除限制，true使用默认限制268402689（0x3FFF x 0x3FFF）。
[options.unlimited]	boolean	false	设置为 true 以移除防止内存耗尽的安全功能（JPEG、PNG、SVG、HEIF）。
[options.autoOrient]	boolean	false	设置为 true 以根据 EXIF Orientation 信息旋转/翻转图像（如果存在）。
[options.sequentialRead]	boolean	true	设置为 false 以使用随机访问而非顺序读取。某些操作会自动执行此行为。
[options.density]	number	72	表示矢量图像的 DPI，范围1到100000。
[options.ignoreIcc]	number	false	是否忽略嵌入的 ICC 配置文件（如果有）。
[options.pages]	number	1	提取多页输入（GIF、WebP、TIFF）的页数，使用 -1 表示全部页。
[options.page]	number	0	多页输入（GIF、WebP、TIFF）开始提取的页码，从0开始。
[options.animated]	boolean	false	设置为 true 以读取动画图像（GIF、WebP、TIFF）的所有帧/页，相当于将 pages 设置为 -1。
[options.raw]	Object		描述原始像素输入图像数据。参见 raw() 了解像素排列顺序。
[options.raw.width]	number		整数像素宽度。
[options.raw.height]	number		整数像素高度。
[options.raw.channels]	number		通道数，介于1到4之间的整数。
[options.raw.premultiplied]	boolean		指示原始输入是否已预乘，设置为 true 以避免 sharp 对图像进行预乘。（可选，默认 false）
[options.create]	Object		描述要创建的新图像。
[options.create.width]	number		整数像素宽度。
[options.create.height]	number		整数像素高度。
[options.create.channels]	number		通道数，为3（RGB）或4（RGBA）。
[options.create.background]	string | Object		由 color 模块解析，用以提取红、绿、蓝和透明度值。
[options.create.noise]	Object		描述要创建的噪声。
[options.create.noise.type]	string		生成的噪声类型，目前仅支持 gaussian。
[options.create.noise.mean]	number		生成噪声像素的均值。
[options.create.noise.sigma]	number		生成噪声像素的标准差。
[options.text]	Object		描述要创建的新文本图像。
[options.text.text]	string		要渲染的文本，UTF-8 字符串。可以包含 Pango 标记，例如 <i>Le</i>Monde。
[options.text.font]	string		用于渲染的字体名称。
[options.text.fontfile]	string		字体文件的绝对文件系统路径，该文件可被 font 使用。
[options.text.width]	number	0	以像素为单位的换行宽度。超出该宽度的文本行将在单词边界处换行。
[options.text.height]	number	0	最大像素高度。当定义时，会忽略 dpi，文本自动适应 width 和 height 所定义的像素分辨率。如果未指定宽度或宽度为0，则忽略此参数。
[options.text.align]	string	“‘left‘“	多行文本的对齐方式（'left'、'centre'、'center'、'right'）。
[options.text.justify]	boolean	false	设为 true 以使文本实现两端对齐。
[options.text.dpi]	number	72	渲染文本的分辨率（大小）。如果指定了 height，此参数不起作用。
[options.text.rgba]	boolean	false	设为 true 以启用 RGBA 输出。这对彩色表情符号渲染或支持 Pango 标记功能（如 <span foreground="red">Red!</span>）很有用。
[options.text.spacing]	number	0	文本行高（磅）。如果未指定，将使用字体行高。
[options.text.wrap]	string	“‘word‘“	当指定宽度时的换行方式，可选值：‘word’、‘char’、‘word-char’（优先单词，回退至字符）或 ‘none’。
[options.join]	Object		描述如何连接输入图像数组。
[options.join.across]	number	1	水平连接的图像数量。
[options.join.animated]	boolean	false	设为 true 以作为动画图像连接这些图像。
[options.join.shim]	number	0	连接图像间插入的像素数。
[options.join.background]	string | Object		由 color 模块解析得到红、绿、蓝和透明度值。
[options.join.halign]	string	“‘left‘“	水平连接图像的对齐方式（'left'、'centre'、'center'、'right'）。
[options.join.valign]	string	“‘top‘“	垂直连接图像的对齐方式（'top'、'centre'、'center'、'bottom'）。
[options.tiff]	Object		描述 TIFF 特定选项。
[options.tiff.subifd]	number	-1	用于 OME-TIFF 的子图像文件目录，默认提取主图像。
[options.svg]	Object		描述 SVG 特定选项。
[options.svg.stylesheet]	string		自定义 SVG 输入的 CSS，应用于 CSS 级联中的用户源。
[options.svg.highBitdepth]	boolean	false	设为 true 以在 32 位/通道（128-bit）而非 8 位/通道（32-bit）RGBA 下渲染 SVG 输入。
[options.pdf]	Object		描述 PDF 特定选项。需要使用全局安装的 libvips，并编译支持 PDFium、Poppler、ImageMagick 或 GraphicsMagick。
[options.pdf.background]	string | Object		用于 PDF 部分透明时的背景色。由 color 模块解析提取红、绿、蓝和透明度值。
[options.openSlide]	Object		描述 OpenSlide 特定选项。需要使用全局安装的 libvips 并编译支持 OpenSlide。
[options.openSlide.level]	number	0	从多级输入中提取的级别，索引从0开始。
[options.jp2]	Object		描述 JPEG 2000 特定选项。需要使用全局安装的 libvips 并编译支持 OpenJPEG。
[options.jp2.oneshot]	boolean	false	设为 true 以单次操作解码平铺的 JPEG 2000 图像，提高兼容性。

示例

sharp('input.jpg')
  .resize(300, 200)
  .toFile('output.jpg', function(err) {
    // output.jpg 是一个宽 300 像素、高 200 像素的图像
    // 包含了 input.jpg 的缩放和裁剪版本
  });

示例

// 从远程 URL 读取图像数据，
// 调整宽度到 300 像素，
// 发出一个 'info' 事件，带有计算的维度，
// 最后将图像数据写入 writableStream
const { body } = fetch('https://...');
const readableStream = Readable.fromWeb(body);
const transformer = sharp()
  .resize(300)
  .on('info', ({ height }) => {
    console.log(`图像高度是 ${height}`);
  });
readableStream.pipe(transformer).pipe(writableStream);

示例

// 创建一个 300x200 的 PNG 图像，像素是半透明的红色
sharp({
  create: {
    width: 300,
    height: 200,
    channels: 4,
    background: { r: 255, g: 0, b: 0, alpha: 0.5 }
  }
})
.png()
.toBuffer()
.then( ... );

示例

// 将动画 GIF 转换为动画 WebP
await sharp('in.gif', { animated: true }).toFile('out.webp');

示例

// 读取原始像素数组并保存为 png
const input = Uint8Array.from([255, 255, 255, 0, 0, 0]); // 或 Uint8ClampedArray
const image = sharp(input, {
  // 因为输入不包含其维度或通道数
  // 我们需要在构造函数选项中指定
  raw: {
    width: 2,
    height: 1,
    channels: 3
  }
});
await image.toFile('my-two-pixels.png');

示例

// 生成 RGB 高斯噪音
await sharp({
  create: {
    width: 300,
    height: 200,
    channels: 3,
    noise: {
      type: 'gaussian',
      mean: 128,
      sigma: 30
    }
 }
}).toFile('noise.png');

示例

// 从文本生成图像
await sharp({
  text: {
    text: 'Hello, world!',
    width: 400, // 最大宽度
    height: 300 // 最大高度
  }
}).toFile('text_bw.png');

示例

// 使用 pango 标记和字体从文本生成 rgba 图像
await sharp({
  text: {
    text: '<span foreground="red">Red!</span><span background="cyan">blue</span>',
    font: 'sans',
    rgba: true,
    dpi: 300
  }
}).toFile('text_rgba.png');

示例

// 将四个输入图像作为 2x2 网格连接，间隔 4 像素
const data = await sharp(
 [image1, image2, image3, image4],
 { join: { across: 2, shim: 4 } }
).toBuffer();

示例

// 从表情符号生成一个两帧的动画图像
const images = ['😀', '😛'].map(text => ({
  text: { text, width: 64, height: 64, channels: 4, rgba: true }
}));
await sharp(images, { join: { animated: true } }).toFile('out.gif');

clone

clone() ⇒ Sharp

快照 Sharp 实例，返回一个新的实例。克隆的实例继承其父实例的输入。这使得多个输出流，并因此多个处理管道能够共享单个输入流。

示例

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 接收自动旋转、调整大小的 readableStream
// secondWritableStream 接收自动旋转，提取的 readableStream 区域

示例

// 创建一个管道，将会下载图像，调整大小并格式化为不同文件
// 使用承诺来知道管道何时完成
const fs = require("fs");
const got = require("got");
const sharpStream = sharp({ failOn: 'none' });

const promises = [];

promises.push(
  sharpStream
    .clone()
    .jpeg({ quality: 100 })
    .toFile("originalFile.jpg")
);

promises.push(
  sharpStream
    .clone()
    .resize({ width: 500 })
    .jpeg({ quality: 80 })
    .toFile("optimized-500.jpg")
);

promises.push(
  sharpStream
    .clone()
    .resize({ width: 500 })
    .webp({ quality: 80 })
    .toFile("optimized-500.webp")
);

// https://github.com/sindresorhus/got/blob/main/documentation/3-streams.md
got.stream("https://www.example.com/some-file.jpg").pipe(sharpStream);

Promise.all(promises)
  .then(res => { console.log("完成!", res); })
  .catch(err => {
    console.error("处理文件时出错，清理一下", err);
    try {
      fs.unlinkSync("originalFile.jpg");
      fs.unlinkSync("optimized-500.jpg");
      fs.unlinkSync("optimized-500.webp");
    } catch (e) {}
  });