betterdisplaycli 0.1.18 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "betterdisplaycli",
-  "version": "0.1.18",
+  "version": "0.2.0",
   "description": "TypeScript bindings for `betterdisplaycli`.",
   "author": "Lucas Garron <code@garron.net>",
   "license": "MIT",
@@ -15,7 +15,7 @@
     }
   },
   "dependencies": {
-    "printable-shell-command": ">=5.0.7"
+    "printable-shell-command": "^5.0.8"
   },
   "devDependencies": {
     "@biomejs/biome": "2.3.9",

package/src/Device.ts

@@ -1,5 +1,5 @@
 import { PrintableShellCommand } from "printable-shell-command";
-import { getDisplayWithSelectorArg, print, type QuietOption } from "./get";
+import { print, type QuietOption } from "./get";
 import { isNotUndefined, ResolutionInfo } from "./ResolutionInfo";
 
 type BOOLEAN_SETTING = "connected" | "hiDPI" | "notch";
@@ -199,23 +199,6 @@ export class Display extends SingleDisplay {
   constructor(public override readonly info: DisplayInfo) {
     super(info);
   }
-
-  static main(): Promise<Display> {
-    return getDisplayWithSelectorArg("--displayWithMainStatus");
-  }
-
-  static fromName(name: string): Promise<Display> {
-    return getDisplayWithSelectorArg(`--name=${name}`);
-  }
-
-  static async tryFromName(name: string): Promise<Display | null> {
-    try {
-      return await getDisplayWithSelectorArg(`--name=${name}`);
-    } catch {
-      // TODO: what is the simplest way to verify this was because there was no such display (as opposed to a general invocation error)?
-      return null;
-    }
-  }
 }
 
 export class VirtualScreen extends SingleDisplay {

package/src/get.ts

@@ -3,6 +3,7 @@ import {
   type Device,
   type DeviceInfo,
   type Display,
+  type DisplayGroup,
   deviceFromInfo,
   type VirtualScreen,
 } from "./Device";
@@ -24,11 +25,13 @@ export function print(
   return command;
 }
 
+type GetDeviceOptions = {
+  ignoreDisplayGroups?: true;
+} & QuietOption;
+
 async function getDeviceInfos<T>(
   printable_shell_command: PrintableShellCommand,
-  options?: {
-    ignoreDisplayGroups?: true;
-  } & QuietOption,
+  options?: GetDeviceOptions,
 ): Promise<T[]> {
   const jsonStream = await print(
     printable_shell_command,
@@ -49,14 +52,10 @@ async function getDeviceInfos<T>(
 }
 
 export async function getAllDevices(
-  options?: {
-    ignoreDisplayGroups?: true;
-  } & QuietOption,
+  options?: GetDeviceOptions,
 ): Promise<(Display | VirtualScreen)[]>;
 export async function getAllDevices(
-  options?: {
-    ignoreDisplayGroups?: boolean;
-  } & QuietOption,
+  options?: GetDeviceOptions,
 ): Promise<Device[]> {
   const jsonStream = await print(
     new PrintableShellCommand(BINARY_NAME, [["get", "--identifiers"]]),
@@ -76,17 +75,50 @@ export async function getAllDevices(
     });
 }
 
+export function getMain(
+  options?: QuietOption,
+): Promise<Display | VirtualScreen> {
+  return getDisplayWithSelectorArg("--displayWithMainStatus", {
+    ...options,
+    ignoreDisplayGroups: true,
+  });
+}
+
+export async function getByName(
+  name: string,
+  options?: GetDeviceOptions,
+): Promise<Display | VirtualScreen>;
+export function getByName(
+  name: string,
+  options?: GetDeviceOptions,
+): Promise<Display | VirtualScreen | DisplayGroup> {
+  return getDisplayWithSelectorArg(`--name=${name}`, options);
+}
+
+export async function tryGetByName(
+  name: string,
+  options?: GetDeviceOptions,
+): Promise<Display | VirtualScreen | undefined>;
+export async function tryGetByName(
+  name: string,
+  options?: GetDeviceOptions,
+): Promise<Display | VirtualScreen | DisplayGroup | undefined> {
+  const devices = await getAllDevices(options);
+  return devices.filter((device) => device.info.name === name)[0];
+}
+
 export async function getDisplayWithSelectorArg(
   arg: "--displayWithMainStatus" | `--name=${string}`,
+  options?: GetDeviceOptions,
 ): Promise<Display> {
   return (
     await getDeviceInfos<Display>(
       new PrintableShellCommand("betterdisplaycli", [
         "get",
         arg,
-        "--type=Display",
         "--identifiers",
       ]),
+      options,
     )
   )[0];
 }

package/src/index.ts

@@ -1,3 +1,9 @@
 export * from "./Device";
-export { connectAllDisplays, getAllDevices } from "./get";
+export {
+  connectAllDisplays,
+  getAllDevices,
+  getByName,
+  getMain,
+  tryGetByName,
+} from "./get";
 export { ResolutionInfo, type ResolutionInfoData } from "./ResolutionInfo";