@revizly/sharp 0.35.0-revizly41 → 0.35.0-revizly42

package/dist/index.d.cts

@@ -658,25 +658,27 @@ declare namespace sharp {
          * @param callback Callback function called on completion with three arguments (err, buffer, info).
          * @returns A sharp instance that can be used to chain operations
          */
-        toBuffer(callback: (err: Error, buffer: Buffer, info: OutputInfo) => void): Sharp;
+        toBuffer(callback: (err: Error, buffer: Buffer<ArrayBuffer>, info: OutputInfo) => void): Sharp;
 
         /**
          * Write output to a Buffer. JPEG, PNG, WebP, AVIF, TIFF, GIF and RAW output are supported.
          * By default, the format will match the input image, except SVG input which becomes PNG output.
+         * The underlying `ArrayBuffer` may be marked as non-transferable by some JavaScript runtimes.
          * @param options resolve options
          * @param options.resolveWithObject Resolve the Promise with an Object containing data and info properties instead of resolving only with data.
          * @returns A promise that resolves with the Buffer data.
          */
-        toBuffer(options?: { resolveWithObject: false }): Promise<Buffer>;
+        toBuffer(options?: { resolveWithObject: false }): Promise<Buffer<ArrayBuffer>>;
 
         /**
          * Write output to a Buffer. JPEG, PNG, WebP, AVIF, TIFF, GIF and RAW output are supported.
          * By default, the format will match the input image, except SVG input which becomes PNG output.
+         * The underlying `ArrayBuffer` may be marked as non-transferable by some JavaScript runtimes.
          * @param options resolve options
          * @param options.resolveWithObject Resolve the Promise with an Object containing data and info properties instead of resolving only with data.
          * @returns A promise that resolves with an object containing the Buffer data and an info object containing the output image format, size (bytes), width, height and channels
          */
-        toBuffer(options: { resolveWithObject: true }): Promise<{ data: Buffer; info: OutputInfo }>;
+        toBuffer(options: { resolveWithObject: true }): Promise<{ data: Buffer<ArrayBuffer>; info: OutputInfo }>;
 
         /**
          * Write output to a Uint8Array backed by a transferable ArrayBuffer. JPEG, PNG, WebP, AVIF, TIFF, GIF and RAW output are supported.

package/dist/index.d.mts

@@ -652,25 +652,27 @@ export interface Sharp extends Duplex {
      * @param callback Callback function called on completion with three arguments (err, buffer, info).
      * @returns A sharp instance that can be used to chain operations
      */
-    toBuffer(callback: (err: Error, buffer: Buffer, info: OutputInfo) => void): Sharp;
+    toBuffer(callback: (err: Error, buffer: Buffer<ArrayBuffer>, info: OutputInfo) => void): Sharp;
 
     /**
      * Write output to a Buffer. JPEG, PNG, WebP, AVIF, TIFF, GIF and RAW output are supported.
      * By default, the format will match the input image, except SVG input which becomes PNG output.
+     * The underlying `ArrayBuffer` may be marked as non-transferable by some JavaScript runtimes.
      * @param options resolve options
      * @param options.resolveWithObject Resolve the Promise with an Object containing data and info properties instead of resolving only with data.
      * @returns A promise that resolves with the Buffer data.
      */
-    toBuffer(options?: { resolveWithObject: false }): Promise<Buffer>;
+    toBuffer(options?: { resolveWithObject: false }): Promise<Buffer<ArrayBuffer>>;
 
     /**
      * Write output to a Buffer. JPEG, PNG, WebP, AVIF, TIFF, GIF and RAW output are supported.
      * By default, the format will match the input image, except SVG input which becomes PNG output.
+     * The underlying `ArrayBuffer` may be marked as non-transferable by some JavaScript runtimes.
      * @param options resolve options
      * @param options.resolveWithObject Resolve the Promise with an Object containing data and info properties instead of resolving only with data.
      * @returns A promise that resolves with an object containing the Buffer data and an info object containing the output image format, size (bytes), width, height and channels
      */
-    toBuffer(options: { resolveWithObject: true }): Promise<{ data: Buffer; info: OutputInfo }>;
+    toBuffer(options: { resolveWithObject: true }): Promise<{ data: Buffer<ArrayBuffer>; info: OutputInfo }>;
 
     /**
      * Write output to a Uint8Array backed by a transferable ArrayBuffer. JPEG, PNG, WebP, AVIF, TIFF, GIF and RAW output are supported.

package/dist/output.cjs

@@ -113,24 +113,20 @@ function toFile (fileOut, callback) {
  * Animated output will also contain `pageHeight` and `pages`.
  * May also contain `textAutofitDpi` (dpi the font was rendered at) if image was created from text.
  *
- * A `Promise` is returned when `callback` is not provided.
+ * The underlying `ArrayBuffer` may be marked as non-transferable by some JavaScript runtimes.
+ * Use {@link #touint8array toUint8Array} for a guaranteed transferable `ArrayBuffer`.
  *
- * @example
- * sharp(input)
- *   .toBuffer((err, data, info) => { ... });
+ * A `Promise` is returned when `callback` is not provided.
  *
  * @example
- * sharp(input)
- *   .toBuffer()
- *   .then(data => { ... })
- *   .catch(err => { ... });
+ * const data = await sharp(input)
+ *   .png()
+ *   .toBuffer();
  *
  * @example
- * sharp(input)
+ * const { data, info } = await sharp(input)
  *   .png()
- *   .toBuffer({ resolveWithObject: true })
- *   .then(({ data, info }) => { ... })
- *   .catch(err => { ... });
+ *   .toBuffer({ resolveWithObject: true });
  *
  * @example
  * const { data, info } = await sharp('my-image.jpg')

package/dist/output.mjs

@@ -113,24 +113,20 @@ function toFile (fileOut, callback) {
  * Animated output will also contain `pageHeight` and `pages`.
  * May also contain `textAutofitDpi` (dpi the font was rendered at) if image was created from text.
  *
- * A `Promise` is returned when `callback` is not provided.
+ * The underlying `ArrayBuffer` may be marked as non-transferable by some JavaScript runtimes.
+ * Use {@link #touint8array toUint8Array} for a guaranteed transferable `ArrayBuffer`.
  *
- * @example
- * sharp(input)
- *   .toBuffer((err, data, info) => { ... });
+ * A `Promise` is returned when `callback` is not provided.
  *
  * @example
- * sharp(input)
- *   .toBuffer()
- *   .then(data => { ... })
- *   .catch(err => { ... });
+ * const data = await sharp(input)
+ *   .png()
+ *   .toBuffer();
  *
  * @example
- * sharp(input)
+ * const { data, info } = await sharp(input)
  *   .png()
- *   .toBuffer({ resolveWithObject: true })
- *   .then(({ data, info }) => { ... })
- *   .catch(err => { ... });
+ *   .toBuffer({ resolveWithObject: true });
  *
  * @example
  * const { data, info } = await sharp('my-image.jpg')

package/lib/index.d.ts

@@ -658,25 +658,27 @@ declare namespace sharp {
          * @param callback Callback function called on completion with three arguments (err, buffer, info).
          * @returns A sharp instance that can be used to chain operations
          */
-        toBuffer(callback: (err: Error, buffer: Buffer, info: OutputInfo) => void): Sharp;
+        toBuffer(callback: (err: Error, buffer: Buffer<ArrayBuffer>, info: OutputInfo) => void): Sharp;
 
         /**
          * Write output to a Buffer. JPEG, PNG, WebP, AVIF, TIFF, GIF and RAW output are supported.
          * By default, the format will match the input image, except SVG input which becomes PNG output.
+         * The underlying `ArrayBuffer` may be marked as non-transferable by some JavaScript runtimes.
          * @param options resolve options
          * @param options.resolveWithObject Resolve the Promise with an Object containing data and info properties instead of resolving only with data.
          * @returns A promise that resolves with the Buffer data.
          */
-        toBuffer(options?: { resolveWithObject: false }): Promise<Buffer>;
+        toBuffer(options?: { resolveWithObject: false }): Promise<Buffer<ArrayBuffer>>;
 
         /**
          * Write output to a Buffer. JPEG, PNG, WebP, AVIF, TIFF, GIF and RAW output are supported.
          * By default, the format will match the input image, except SVG input which becomes PNG output.
+         * The underlying `ArrayBuffer` may be marked as non-transferable by some JavaScript runtimes.
          * @param options resolve options
          * @param options.resolveWithObject Resolve the Promise with an Object containing data and info properties instead of resolving only with data.
          * @returns A promise that resolves with an object containing the Buffer data and an info object containing the output image format, size (bytes), width, height and channels
          */
-        toBuffer(options: { resolveWithObject: true }): Promise<{ data: Buffer; info: OutputInfo }>;
+        toBuffer(options: { resolveWithObject: true }): Promise<{ data: Buffer<ArrayBuffer>; info: OutputInfo }>;
 
         /**
          * Write output to a Uint8Array backed by a transferable ArrayBuffer. JPEG, PNG, WebP, AVIF, TIFF, GIF and RAW output are supported.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@revizly/sharp",
   "description": "High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP, GIF, AVIF and TIFF images",
-  "version": "0.35.0-revizly41",
+  "version": "0.35.0-revizly42",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",
   "contributors": [
@@ -163,25 +163,30 @@
     "semver": "^7.8.5"
   },
   "optionalDependencies": {
-    "@revizly/sharp-libvips-linux-arm64": "1.0.42",
-    "@revizly/sharp-libvips-linux-x64": "1.0.42",
-    "@revizly/sharp-linux-arm64": "0.35.0-revizly41",
-    "@revizly/sharp-linux-x64": "0.35.0-revizly41"
+    "@revizly/sharp-libvips-linux-arm64": "1.0.43",
+    "@revizly/sharp-libvips-linux-x64": "1.0.43",
+    "@revizly/sharp-linux-arm64": "0.35.0-revizly42",
+    "@revizly/sharp-linux-x64": "0.35.0-revizly42"
+  },
+  "peerDependenciesMeta": {
+    "@types/node": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@biomejs/biome": "^2.5.1",
     "@cpplint/cli": "^0.1.0",
     "@emnapi/runtime": "^1.11.1",
-    "@revizly/sharp-libvips-dev": "1.0.42",
+    "@revizly/sharp-libvips-dev": "1.0.43",
     "@types/node": "*",
     "emnapi": "^1.11.1",
     "exif-reader": "^2.0.3",
     "extract-zip": "^2.0.1",
     "icc": "^4.0.0",
-    "node-addon-api": "^8.8.0",
+    "node-addon-api": "^8.9.0",
     "node-gyp": "^12.4.0",
     "publint": "^0.3.21",
-    "tar-fs": "^3.1.2",
+    "tar-fs": "^3.1.3",
     "tsd": "^0.33.0"
   },
   "license": "Apache-2.0",