@vizzly-testing/honeydiff 0.1.0 → 0.1.1

package/README.md

@@ -68,10 +68,12 @@ if (result.diffClusters) {
 **Async (recommended)**
 - `compare(img1, img2, options?): Promise<DiffResult>` - Full comparison
 - `quickCompare(img1, img2): Promise<boolean>` - Quick check
+- `getDimensions(img): Promise<{ width: number, height: number }>` - Get image dimensions
 
 **Sync (blocks event loop)**
 - `compareSync(img1, img2, options?): DiffResult`
 - `quickCompareSync(img1, img2): boolean`
+- `getDimensionsSync(img): { width: number, height: number }` - Get image dimensions
 
 Inputs: `string` (file path) or `Buffer`
 
@@ -121,6 +123,24 @@ interface DiffResult {
 
 ## Examples
 
+**Get Image Dimensions**
+```javascript
+const { getDimensions, getDimensionsSync } = require('@vizzly-testing/honeydiff');
+
+// Async
+let dims = await getDimensions('screenshot.png');
+console.log(`Image is ${dims.width}x${dims.height} pixels`);
+// Output: Image is 1920x1080 pixels
+
+// Sync
+let dims = getDimensionsSync('screenshot.png');
+console.log(`Image is ${dims.width}x${dims.height} pixels`);
+
+// Works with buffers too
+let buffer = fs.readFileSync('image.png');
+let dims = await getDimensions(buffer);
+```
+
 **Buffers**
 ```javascript
 const fs = require('fs');

package/index.d.ts

@@ -274,3 +274,50 @@ export function quickCompareSync(
   img1: ImageInput,
   img2: ImageInput
 ): boolean;
+
+// ============================================================================
+// Dimensions API
+// ============================================================================
+
+export interface ImageDimensions {
+  /** Image width in pixels */
+  width: number;
+  /** Image height in pixels */
+  height: number;
+}
+
+/**
+ * Get image dimensions asynchronously (recommended)
+ *
+ * Fast utility to retrieve image width and height without loading the full image data.
+ * Useful for pre-flight checks before comparison.
+ *
+ * @param img - Image (file path or Buffer)
+ * @returns Promise resolving to { width, height } in pixels
+ *
+ * @example
+ * ```typescript
+ * const dims = await getDimensions('screenshot.png');
+ * console.log(`Image is ${dims.width}x${dims.height} pixels`);
+ * // Output: Image is 1920x1080 pixels
+ * ```
+ */
+export function getDimensions(img: ImageInput): Promise<ImageDimensions>;
+
+/**
+ * Get image dimensions synchronously (blocks event loop)
+ *
+ * Fast utility to retrieve image width and height without loading the full image data.
+ * Use this only when you need blocking behavior.
+ *
+ * @param img - Image (file path or Buffer)
+ * @returns { width, height } in pixels
+ *
+ * @example
+ * ```typescript
+ * const dims = getDimensionsSync('screenshot.png');
+ * console.log(`Image is ${dims.width}x${dims.height} pixels`);
+ * // Output: Image is 1920x1080 pixels
+ * ```
+ */
+export function getDimensionsSync(img: ImageInput): ImageDimensions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vizzly-testing/honeydiff",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "High-performance image diffing for Node.js - Native bindings to Honeydiff Rust library",
   "main": "index.js",
   "types": "index.d.ts",
@@ -55,6 +55,11 @@
     "index.d.ts",
     "load-platform.js",
     "platforms/*.node",
+    "README.md",
+    "index.js",
+    "index.d.ts",
+    "load-platform.js",
+    "platforms/*.node",
     "README.md"
   ],
   "engines": {