🤖 Merge PR DefinitelyTyped#73350 Update types to match actual library behavior in @types/screenshot-desktop by @radiantbeing

Author: radiantbeing

types/screenshot-desktop/index.d.ts

@@ -3,26 +3,37 @@
 export = screenshotDesktop;
 
 declare function screenshotDesktop(
-    options?: { format?: screenshotDesktop.ImageFormat; screen?: screenshotDesktop.DisplayID },
-): Promise<Buffer>;
+    options?: screenshotDesktop.ScreenshotOptionsWithoutFilename,
+): Promise<NonSharedBuffer>;
 declare function screenshotDesktop(
-    options?: { filename: string; format?: screenshotDesktop.ImageFormat; screen?: screenshotDesktop.DisplayID },
+    options?: screenshotDesktop.ScreenshotOptionsWithFilename,
 ): Promise<string>;
 
 declare namespace screenshotDesktop {
-    type DisplayID = number;
-
-    type ImageFormat =
-        | "bmp"
-        | "emf"
-        | "exif"
-        | "jpg"
-        | "jpeg"
-        | "gif"
-        | "png"
-        | "tiff"
-        | "wmf";
-
-    function listDisplays(): Promise<Array<{ id: DisplayID; name: string }>>;
-    function all(): Promise<Array<{ id: DisplayID; name: string }>>;
+    interface ScreenshotOptions {
+        filename?: string;
+        format?: ImageFormat;
+        screen?: DisplayID;
+        linuxLibrary?: "scrot" | "imagemagick";
+    }
+
+    interface ScreenshotOptionsWithFilename extends ScreenshotOptions {
+        filename: string;
+    }
+
+    interface ScreenshotOptionsWithoutFilename extends ScreenshotOptions {
+        filename?: "";
+    }
+
+    interface Display {
+        id: number | string;
+        name: string;
+    }
+
+    type DisplayID = Display["id"];
+
+    type ImageFormat = "jpg" | "png";
+
+    function listDisplays(): Promise<Array<Display>>;
+    function all(): Promise<Array<NonSharedBuffer>>;
 }

types/screenshot-desktop/package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/screenshot-desktop",
-    "version": "1.12.9999",
+    "version": "1.15.9999",
     "projects": [
         "https://github.com/bencevans/screenshot-desktop"
     ],

types/screenshot-desktop/screenshot-desktop-tests.ts

@@ -1,35 +1,36 @@
 import screenshot = require("screenshot-desktop");
 
-screenshot().then((img) => {
-    // img: Buffer filled with jpg goodness
-    // ...
-}).catch((err) => {
-    // ...
-});
+// Buffer filled with jpg goodness
+// $ExpectType Promise<NonSharedBuffer> || Promise<Buffer>
+screenshot();
 
-screenshot({ format: "png" }).then((img) => {
-    // img: Buffer filled with png goodness
-    // ...
-}).catch((err) => {
-    // ...
-});
+// Buffer filled with png goodness
+// $ExpectType Promise<NonSharedBuffer> || Promise<Buffer>
+screenshot({ format: "png" });
 
-screenshot.listDisplays().then((displays) => {
-    // displays: [{ id, name }, { id, name }]
-    screenshot({ screen: displays[displays.length - 1].id })
-        .then((img) => {
-            // img: Buffer of screenshot of the last display
-        });
-});
+// Buffer when filename is empty
+// $ExpectType Promise<NonSharedBuffer> || Promise<Buffer>
+screenshot({ filename: "" });
 
-screenshot.all().then((imgs) => {
-    // imgs: an array of Buffers, one for each screen
-});
+// absolute path to screenshot
+// created in current working directory named shot.jpg
+// $ExpectType Promise<string>
+screenshot({ filename: "shot.jpg" });
 
-screenshot({ filename: "shot.jpg" }).then((imgPath) => {
-    // imgPath: absolute path to screenshot
-    // created in current working directory named shot.png
+// absolute paths work too. so do pngs
+// $ExpectType Promise<string>
+screenshot({ filename: "/Users/$USER/Desktop/demo.png" });
+
+// an array of available displays
+// $ExpectType Promise<Display[]>
+screenshot.listDisplays();
+
+screenshot.listDisplays().then((displays) => {
+    // Buffer of screenshot of the last display
+    // $ExpectType Promise<NonSharedBuffer> || Promise<Buffer>
+    screenshot({ screen: displays[displays.length - 1].id });
 });
 
-// absolute paths work too. so do pngs
-screenshot({ filename: "/Users/brian/Desktop/demo.png" });
+// an array of Buffers or strings, one for each screen
+// $ExpectType Promise<NonSharedBuffer[]> || Promise<Buffer[]>
+screenshot.all();