0.0.7

Author: mcnaveen

package.json

@@ -1,6 +1,6 @@
 {
   "name": "blurhash-from-url",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Simple utility to generate blurhash from Image URL",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",

rollup.config.js

@@ -11,6 +11,7 @@ export default {
   external: [
     ...Object.keys(pkg.dependencies || {}),
     ...Object.keys(pkg.peerDependencies || {}),
+    "fs",
   ],
 
   plugins: [typescript({ typescript: require("typescript") })],

src/index.ts

@@ -1,30 +1,60 @@
 import fetch from "node-fetch";
-import { encode, decode } from "blurhash";
+import fs from "fs";
+import { encode } from "blurhash";
 import sharp from 'sharp';
 import sizeOf from "image-size";
 
 export interface IOptions {
     size?: number;
+    offline?: boolean;
 }
 
-export interface IInput {
-    url: string;
-    options?: IOptions;
-}
 export interface IOutput {
     encoded: string;
     width: number;
     height: number;
 }
 
-export const blurhashFromURL = async (url: string, options: IOptions = {}) => {
-    const { size = 32 } = options;
+/**
+ * Generate a Blurhash string from a given image URL or local path.
+ *
+ * @param {string} source - The image URL or local path to the image file.
+ * @param {IOptions} [options] - The optional configuration options.
+ * @param {number} [options.size=32] - The desired size of the image for encoding the Blurhash.
+ * @param {boolean} [options.offline=false] - Set to `true` if the image source is a local path, `false` if it's a URL.
+ * @returns {Promise<IOutput>} The Promise that resolves to the encoded Blurhash string, along with the image width and height.
+ * @default size 32
+ * @default offline false
+ * @example
+ * ```js
+ * import { blurhashFromURL } from "blurhash-from-url";
+ * 
+ * const output = await blurhashFromURL("https://i.imgur.com/NhfEdg2.png", {
+ *    size: 32,
+ * });
+ * 
+ * console.log(output);
+ * ```
+ */
+export const blurhashFromURL = async (source: string, options: IOptions = {}): Promise<IOutput> => {
+    const { size = 32, offline = false } = options;
+
+    let width, height, returnedBuffer;
 
-    const response = await fetch(url);
-    const arrayBuffer = await response.arrayBuffer();
-    const returnedBuffer = Buffer.from(arrayBuffer);
+    if (offline) {
+        const { width: localWidth, height: localHeight } = sizeOf(source);
+        width = localWidth;
+        height = localHeight;
+        returnedBuffer = await sharp(fs.readFileSync(source)).toBuffer();
+    } else {
+        const response = await fetch(source);
+        const arrayBuffer = await response.arrayBuffer();
+        returnedBuffer = Buffer.from(arrayBuffer);
 
-    const { width, height, } = sizeOf(returnedBuffer);
+        const { width: remoteWidth, height: remoteHeight } = sizeOf(returnedBuffer);
+        width = remoteWidth;
+        height = remoteHeight;
+    }
 
     const { info, data } = await sharp(returnedBuffer)
         .resize(size, size, {
@@ -36,7 +66,6 @@ export const blurhashFromURL = async (url: string, options: IOptions = {}) => {
             resolveWithObject: true,
         });
 
-
     const encoded = encode(
         new Uint8ClampedArray(data),
         info.width,

test/index.js

@@ -1,10 +1,26 @@
 const { blurhashFromURL } = require("../dist/index.js");
 
-async function getBlurhash() {
+/* Remote Image */
+async function getRemoteBlurhash() {
   const output = await blurhashFromURL("https://i.imgur.com/NhfEdg2.png", {
-    size: 600,
+    size: 32,
+    offline: true,
   });
+  console.log("\n 🪄 Remote Image Blurhash\n");
   console.log(output);
+  console.log("\n");
 }
 
-getBlurhash();
+getRemoteBlurhash();
+
+/* Local Image */
+async function getLocalBlurhash() {
+  const output = await blurhashFromURL("./image/cover.png", {
+    size: 32,
+    offline: true,
+  });
+  console.log("\n 🪄 Local Image Blurhash\n");
+  console.log(output);
+}
+
+getLocalBlurhash();