betterdisplaycli 0.2.2 → 0.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "betterdisplaycli",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "TypeScript bindings for `betterdisplaycli`.",
   "author": "Lucas Garron <code@garron.net>",
   "license": "MIT",

package/src/Device.ts

@@ -1,9 +1,16 @@
 import { PrintableShellCommand } from "printable-shell-command";
-import { print, type QuietOption } from "./get";
+import {
+  type DetachOption,
+  print,
+  type QuietOption,
+  shellOutSilentOrDetach,
+} from "./get";
 import { isNotUndefined, ResolutionInfo } from "./ResolutionInfo";
 
 type BOOLEAN_SETTING = "connected" | "hiDPI" | "notch";
 type STRING_SETTING = "resolution";
+type FLOAT_SETTING = "brightness";
+type INTEGER_SETTING = "bit-depth" | "rotation";
 
 export type NumberString = string;
 
@@ -76,34 +83,40 @@ class SingleDisplay extends Device {
     set: async (
       settingName: BOOLEAN_SETTING,
       on: boolean,
-      options?: QuietOption,
+      options?: QuietOption & DetachOption,
     ): Promise<void> => {
-      await print(
-        new PrintableShellCommand("betterdisplaycli", [
-          "set",
-          `--name=${this.info.name}`,
-          `--${settingName}=${on ? "on" : "off"}`,
-        ]),
-        { argumentLineWrapping: "inline" },
-        options,
-      ).shellOut({ print: false });
+      await shellOutSilentOrDetach(
+        print(
+          new PrintableShellCommand("betterdisplaycli", [
+            "set",
+            `--name=${this.info.name}`,
+            `--${settingName}=${on ? "on" : "off"}`,
+          ]),
+          { argumentLineWrapping: "inline" },
+          options,
+        ),
+      );
     },
 
     toggle: async (
       settingName: BOOLEAN_SETTING,
-      options?: QuietOption,
+      options?: QuietOption & DetachOption,
     ): Promise<void> => {
-      await print(
-        new PrintableShellCommand("betterdisplaycli", [
-          "toggle",
-          `--name=${this.info.name}`,
-          `--${settingName}`,
-        ]),
-        { argumentLineWrapping: "inline" },
+      await shellOutSilentOrDetach(
+        print(
+          new PrintableShellCommand("betterdisplaycli", [
+            "toggle",
+            `--name=${this.info.name}`,
+            `--${settingName}`,
+          ]),
+          { argumentLineWrapping: "inline" },
+          options,
+        ),
         options,
-      ).shellOut({ print: false });
+      );
     },
   };
+
   string = {
     get: async (
       settingName: STRING_SETTING,
@@ -123,17 +136,91 @@ class SingleDisplay extends Device {
     set: async (
       settingName: STRING_SETTING,
       value: string,
+      options?: QuietOption & DetachOption,
+    ): Promise<void> => {
+      await shellOutSilentOrDetach(
+        print(
+          new PrintableShellCommand("betterdisplaycli", [
+            "set",
+            `--name=${this.info.name}`,
+            `--${settingName}=${value}`,
+          ]),
+          { argumentLineWrapping: "inline" },
+          options,
+        ),
+      );
+    },
+  };
+
+  float = {
+    get: async (
+      settingName: FLOAT_SETTING,
       options?: QuietOption,
+    ): Promise<number> => {
+      const value = await print(
+        new PrintableShellCommand("betterdisplaycli", [
+          "get",
+          `--name=${this.info.name}`,
+          `--${settingName}`,
+        ]),
+        { argumentLineWrapping: "inline" },
+        options,
+      ).text({ trimTrailingNewlines: "single-required" });
+      return parseFloat(value);
+    },
+
+    set: async (
+      settingName: FLOAT_SETTING,
+      value: number,
+      options?: QuietOption & DetachOption,
     ): Promise<void> => {
-      await print(
+      await shellOutSilentOrDetach(
+        print(
+          new PrintableShellCommand("betterdisplaycli", [
+            "set",
+            `--name=${this.info.name}`,
+            `--${settingName}=${value}`,
+          ]),
+          { argumentLineWrapping: "inline" },
+          options,
+        ),
+      );
+    },
+  };
+
+  int = {
+    get: async (
+      settingName: INTEGER_SETTING,
+      options?: QuietOption,
+    ): Promise<number> => {
+      const value = await print(
         new PrintableShellCommand("betterdisplaycli", [
-          "set",
+          "get",
           `--name=${this.info.name}`,
-          `--${settingName}=${value}`,
+          `--${settingName}`,
         ]),
         { argumentLineWrapping: "inline" },
         options,
-      ).shellOut({ print: false });
+      ).text({ trimTrailingNewlines: "single-required" });
+      return parseInt(value, 10);
+    },
+
+    set: async (
+      settingName: INTEGER_SETTING,
+      value: number,
+      options?: QuietOption & DetachOption,
+    ): Promise<void> => {
+      await shellOutSilentOrDetach(
+        print(
+          new PrintableShellCommand("betterdisplaycli", [
+            "set",
+            `--name=${this.info.name}`,
+            `--${settingName}=${value}`,
+          ]),
+          { argumentLineWrapping: "inline" },
+          options,
+        ),
+      );
     },
   };
 
@@ -141,17 +228,23 @@ class SingleDisplay extends Device {
     get: async (): Promise<ResolutionInfo> => {
       return ResolutionInfo.fromString(await this.string.get("resolution"));
     },
-    // The return value indicates if any changes were needed (and performed)
+    /**
+     * The return value indicates if any changes were
+     *
+     * - needed and
+     * - performed successfully (non-detached) or initiated successfully (detached).
+     */
     set: async (
       resolutionInfo: ResolutionInfo,
-      options?: QuietOption,
+      options?: QuietOption & DetachOption,
     ): Promise<boolean> => {
       const currentResolution = await this.resolution.get();
 
       const args: string[] = [];
+      // TODO: implement batch changes.
       if (
         resolutionInfo.width !== currentResolution.width ||
-        resolutionInfo.width !== currentResolution.height
+        resolutionInfo.height !== currentResolution.height
       ) {
         args.push(`--resolution=${resolutionInfo.logicalResolutionString()}`);
       }
@@ -159,7 +252,7 @@ class SingleDisplay extends Device {
         isNotUndefined(resolutionInfo.hiDPI) &&
         resolutionInfo.hiDPI !== currentResolution.hiDPI
       ) {
-        args.push(`--hiDPI=${resolutionInfo.hiDPI}`);
+        args.push(`--hiDPI=${resolutionInfo.hiDPI ? "on" : "off"}`);
       }
       if (
         isNotUndefined(resolutionInfo.notch) &&
@@ -173,15 +266,17 @@ class SingleDisplay extends Device {
         return false;
       }
 
-      await print(
-        new PrintableShellCommand("betterdisplaycli", [
-          "set",
-          `--name=${this.info.name}`,
-          ...args,
-        ]),
-        { argumentLineWrapping: "inline" },
-        options,
-      ).shellOut({ print: false });
+      await shellOutSilentOrDetach(
+        print(
+          new PrintableShellCommand("betterdisplaycli", [
+            "set",
+            `--name=${this.info.name}`,
+            ...args,
+          ]),
+          { argumentLineWrapping: "inline" },
+          options,
+        ),
+      );
       return true;
     },
   };

package/src/get.ts

@@ -14,6 +14,10 @@ export interface QuietOption {
   quiet?: boolean;
 }
 
+export interface DetachOption {
+  detach?: boolean;
+}
+
 export function print(
   command: PrintableShellCommand,
   printOptions?: Parameters<PrintableShellCommand["print"]>[0],
@@ -25,6 +29,17 @@ export function print(
   return command;
 }
 
+export async function shellOutSilentOrDetach(
+  command: PrintableShellCommand,
+  options?: DetachOption,
+): Promise<void> {
+  if (options?.detach) {
+    command.spawnDetached();
+  } else {
+    await command.shellOut({ print: false });
+  }
+}
+
 type GetDeviceOptions = {
   ignoreDisplayGroups?: true;
 } & QuietOption;