Let Jimp.read accept a Buffer (#1332)

jimp-dev · Sep 7, 2024 · 11cd408 · 11cd408
1 parent 314718f
commit 11cd408
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -201,7 +201,7 @@ export function createJimp<
     }
 
     /**
-     * Create a Jimp instance from a URL or a file path
+     * Create a Jimp instance from a URL, a file path, or a Buffer
      * @example
      * ```ts
      * import { Jimp } from "jimp";
@@ -213,9 +213,13 @@ export function createJimp<
      * const image = await Jimp.read("https://upload.wikimedia.org/wikipedia/commons/0/01/Bot-Test.jpg");
      * ```
      */
-    static async read(url: string) {
+    static async read(url: string | Buffer | ArrayBuffer) {
+      if (Buffer.isBuffer(url) || url instanceof ArrayBuffer) {
+        return this.fromBuffer(url);
+      }
+
       if (existsSync(url)) {
-        return Jimp.fromBuffer(await readFile(url));
+        return this.fromBuffer(await readFile(url));
       }
 
       const [fetchErr, response] = await to(fetch(url));

diff --git a/packages/docs/src/content/docs/guides/migrate-to-v1.mdx b/packages/docs/src/content/docs/guides/migrate-to-v1.mdx
@@ -91,6 +91,8 @@ async function main() {
 }
 ```
 
+It will also read from a `Buffer` or `ArrayBuffer`.
+
 ### `Jimp.fromBuffer`
 
 You can load an image from a buffer.