Added types

examples/index.js

@@ -0,0 +1,22 @@
+const { cropImage } = require("cropify");
+const fs = require("fs")
+
+const imagePath = 'https://th.bing.com/th/id/OIGP.914kwCtAqWQ7Lkx5hT2B?pid=ImgGn';
+
+const cropX = 0;
+const cropY = 0;
+const cropWidth = 1280;
+const cropHeight = 720;
+const borderRadius = 80;
+
+cropImage({
+    imagePath: imagePath,
+    x: cropX,
+    y: cropY,
+    width: cropWidth,
+    height: cropHeight,
+    borderRadius: borderRadius,
+    cropCenter: true
+}).then(x => {
+    fs.writeFileSync("cropped-image.png", x);
+});

index.d.ts

@@ -9,6 +9,4 @@ interface cropOption {
     cropCenter?: boolean
 }
 
-declare function cropImage(options: cropOption): Promise<Buffer>;
-
-export { cropImage }
+export declare function cropImage(options: cropOption): Promise<Buffer>;

index.js

@@ -61,7 +61,7 @@ async function cropImage({
         // Draw image
         ctx.drawImage(image, x, y, scaledWidth, scaledHeight);
 
-        return canvas.toDataURL("image/png")
+        return canvas.toBuffer("image/png");
     } catch (e) {
         throw new Error(e.message)
     }

package.json

@@ -2,12 +2,16 @@
   "name": "cropify",
   "types": "./index.d.ts",
   "description": "Crop and round image corners seamlessly.",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "main": "index.js",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -23,16 +27,14 @@
   "dependencies": {
     "@napi-rs/canvas": "^0.1.44"
   },
-  "devDependencies": {},
+  "devDependencies": {
+    "@types/node": "^20.11.19"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/unburn/cropify.git"
   },
   "bugs": {
     "url": "https://github.com/unburn/cropify/issues"
-  },
-  "funding": {
-    "type": "githubsponser",
-    "url": "https://github.com/sponsors/flameface"
   }
 }

readme.md

@@ -1,23 +1,42 @@
-## About
-**Cropify** helps to crop and round image corners seamlessly.
+<img src="https://ik.imagekit.io/unburn/Cropify.svg"/>
 
-## Features
+<p align="center">Cropify helps to crop and round image corners seamlessly.</p>
+
+<p align="center">
+    <a href="https://github.com/unburn/cropify"><b>Github</b></a> •
+    <a href="https://discord.gg/66uGX7t4ww"><b>Support</b></a>
+</p>
+
+<div align="center">
+
+[![NPM Version](https://img.shields.io/npm/v/cropify?style=flat-square&color=%2300ADD3)](https://www.npmjs.com/package/cropify)
+[![NPM Downloads](https://img.shields.io/npm/dw/cropify?style=flat-square&color=%2300ADD3)](https://www.npmjs.com/package/cropify)
+[![NPM License](https://img.shields.io/npm/l/cropify?style=flat-square&color=%2300ADD3)](https://github.com/unburn/cropify/blob/main/LICENCE)
+[![GitHub Repo stars](https://img.shields.io/github/stars/unburn/cropify?style=flat-square&color=%2300ADD3)](https://github.com/unburn/cropify)
+
+</div>
+
+<div align="center">
+<a href="https://github.com/sponsors/flameface"><img src="https://ik.imagekit.io/unburn/SupportCropify.svg"/></a>
+</div>
+
+# Features
 - Crop images with precision using the Canvas API.
 - Optional support for rounding corners with a customizable border radius.
 - Designed for simplicity and performance.
 - Upscale and cover image.
 
-## Installation
+# Installation
 ```
 npm install cropify
 ```
 
-## Usage
+# Usage
 ```javascript
 const { cropImage } = require("cropify");
 const fs = require("fs")
 
-const imagePath = 'https://storage.googleapis.com/pai-images/8c27ed6e3c85463a8db958ecb596594e.jpeg';
+const imagePath = 'https://th.bing.com/th/id/OIGP.914kwCtAqWQ7Lkx5hT2B?pid=ImgGn';
 
 const cropX = 0;
 const cropY = 0;
@@ -31,14 +50,17 @@ cropImage({
     y: cropY,
     width: cropWidth,
     height: cropHeight,
-    borderRadius: borderRadius
+    borderRadius: borderRadius,
+    cropCenter: true
 }).then(x => {
     fs.writeFileSync("cropped-image.png", x);
 });
 ```
 
+> **Note**: The image used in this example is generated using DALL-E
+
 ## Output
-![example](./assets/example.png)
+![example](https://ik.imagekit.io/unburn/CropifyExample.svg)
 
----
-If you need help or want some features to be added, join our official [discord](https://discord.com/invite/qDysF95NWh) community.
+# Licence
+[MIT](https://github.com/unburn/cropify/blob/main/LICENCE)