Browse Source

docs: document the Event interface (#16966)

* docs: document the Event interface

* update docs deps

* pull new VoidFunction update
Shelley Vohr 6 years ago
parent
commit
1e8ac79e6f
2 changed files with 11 additions and 2 deletions
  1. 9 0
      docs/api/structures/event.md
  2. 2 2
      package.json

+ 9 - 0
docs/api/structures/event.md

@@ -0,0 +1,9 @@
+# Event Object extends `GlobalEvent`
+
+* `preventDefault` VoidFunction
+* `sender` WebContents
+* `returnValue` any
+* `ctrlKey` Boolean (optional) - whether the Control key was used in an accelerator to trigger the Event
+* `metaKey` Boolean (optional) - whether a meta key was used in an accelerator to trigger the Event
+* `shiftKey` Boolean (optional) - whether a Shift key was used in an accelerator to trigger the Event
+* `altKey` Boolean (optional) - whether an Alt key was used in an accelerator to trigger the Event

+ 2 - 2
package.json

@@ -14,8 +14,8 @@
     "colors": "^1.1.2",
     "dotenv-safe": "^4.0.4",
     "dugite": "^1.45.0",
-    "electron-docs-linter": "^2.4.0",
-    "electron-typescript-definitions": "^7.0.0",
+    "electron-docs-linter": "^2.5.0",
+    "electron-typescript-definitions": "^8.1.0",
     "eslint": "^5.13.0",
     "eslint-config-standard": "^12.0.0",
     "eslint-plugin-mocha": "^5.2.0",