feat: add refreshRate and isAsleep

Author: codebytere

README.md

@@ -33,6 +33,8 @@ Display objects take the following format:
   * `width` Number - The width of the rectangle.
   * `height` Number - The height of the rectangle.
 * `internal` Boolean - `true` for an internal display and `false` for an external display.
+* `isAsleep` Boolean -  Whether or not the display is sleeping.
+* `refreshRate` Number - Returns the refresh rate of the specified display.
 
 ### `displays.getAllDisplays()`
 
@@ -46,13 +48,15 @@ console.log(allDisplays[0])
 /* Prints:
 [
   {
-    id: 2077749241,
+    id: 69734406,
     name: 'Built-in Retina Display',
-    isMonochrome: false,
+    refreshRate: 0,
     supportedWindowDepths: [
       264, 516, 520, 528,
       544,   0,   0,   0
     ],
+    isAsleep: false,
+    isMonochrome: false,
     colorSpace: { name: 'Color LCD', componentCount: 3 },
     depth: 520,
     scaleFactor: 2,
@@ -76,13 +80,15 @@ const primary = displays.getPrimaryDisplay()
 console.log(primary)
 /* Prints:
 {
-  id: 2077749241,
+  id: 69734406,
   name: 'Built-in Retina Display',
-  isMonochrome: false,
+  refreshRate: 0,
   supportedWindowDepths: [
     264, 516, 520, 528,
     544,   0,   0,   0
   ],
+  isAsleep: false,
+  isMonochrome: false,
   colorSpace: { name: 'Color LCD', componentCount: 3 },
   depth: 520,
   scaleFactor: 2,
@@ -107,13 +113,15 @@ const display = displays.getDisplayByID(2077749241)
 console.log(display)
 /* Prints:
 {
-  id: 2077749241,
+  id: 69734406,
   name: 'Built-in Retina Display',
-  isMonochrome: false,
+  refreshRate: 0,
   supportedWindowDepths: [
     264, 516, 520, 528,
     544,   0,   0,   0
   ],
+  isAsleep: false,
+  isMonochrome: false,
   colorSpace: { name: 'Color LCD', componentCount: 3 },
   depth: 520,
   scaleFactor: 2,

displays.mm

@@ -41,7 +41,16 @@
   return obj;
 }
 
-// Creates an object containing all properties of an NSScreen.
+// Returns whether or not the display is monochrome.
+bool GetIsMonochrome() {
+  CFStringRef app = CFSTR("com.apple.CoreGraphics");
+  CFStringRef key = CFSTR("DisplayUseForcedGray");
+  Boolean key_valid = false;
+
+  return CFPreferencesGetAppBooleanValue(key, app, &key_valid) ? true : false;
+}
+
+// Creates an object containing all properties of an display.
 Napi::Object BuildDisplay(Napi::Env env, NSScreen *nsscreen) {
   Napi::Object display = Napi::Object::New(env);
 
@@ -53,17 +62,13 @@
     display.Set("name", std::string([[nsscreen localizedName] UTF8String]));
   }
 
-  CFStringRef app = CFSTR("com.apple.CoreGraphics");
-  CFStringRef key = CFSTR("DisplayUseForcedGray");
-  Boolean key_valid = false;
-  bool monochrome =
-      CFPreferencesGetAppBooleanValue(key, app, &key_valid) ? true : false;
-  display.Set("isMonochrome", monochrome);
-
-  Napi::Array window_depths =
-      CArrayToNapiArray(env, [nsscreen supportedWindowDepths]);
-  display.Set("supportedWindowDepths", window_depths);
+  CGDisplayModeRef display_mode = CGDisplayCopyDisplayMode(display_id);
+  display.Set("refreshRate", CGDisplayModeGetRefreshRate(display_mode));
 
+  display.Set("supportedWindowDepths",
+              CArrayToNapiArray(env, [nsscreen supportedWindowDepths]));
+  display.Set("isAsleep", CGDisplayIsAsleep(display_id) ? true : false);
+  display.Set("isMonochrome", GetIsMonochrome());
   display.Set("colorSpace", NSColorSpaceToObject(env, [nsscreen colorSpace]));
   display.Set("depth", static_cast<int>([nsscreen depth]));
   display.Set("scaleFactor", [nsscreen backingScaleFactor]);

test/module.spec.js

@@ -17,6 +17,8 @@ describe('node-system-displays', () => {
       expect(display).to.have.property('isMonochrome').that.is.a('boolean')
       expect(display).to.have.property('depth').that.is.a('number')
       expect(display).to.have.property('internal').that.is.a('boolean')
+      expect(display).to.have.property('isAsleep').that.is.a('boolean')
+      expect(display).to.have.property('refreshRate').that.is.a('number')
 
       expect(display).to.have.property('colorSpace').that.is.an('object')
       const { name, componentCount } = display.colorSpace