Make "type" an optional parameter for WakeLock.request(). (#291)

And make it default to "screen". Existing code continues to work, while new code can also call `navigator.wakeLock.request()` to request a screen wake lock. Issues #253, #255 and #288 indicate that there is a preference for making `type` an optional parameter that just got overlooked.
w3c · Oct 5, 2020 · 58a7bb0 · 58a7bb0
1 parent f89b85a
commit 58a7bb0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/explainer.md b/explainer.md
@@ -62,8 +62,9 @@ if (lock.released === false) {
 
 ### Requesting permission to use WakeLocks
 To use the API, one must request access via
-`navigator.wakeLock.request("screen")`. This returns a promise which, if
-allowed by the user, resolves with a `WakeLockSentinel`.
+`navigator.wakeLock.request("screen")` (`"screen"` is optional). This
+returns a promise which, if allowed by the user, resolves with a
+`WakeLockSentinel`.
 
 ```js
 let sentinel;

diff --git a/index.html b/index.html
@@ -326,7 +326,7 @@ <h2>
       <pre class="idl">
         [SecureContext, Exposed=(Window)]
         interface WakeLock {
-          Promise&lt;WakeLockSentinel&gt; request(WakeLockType type);
+          Promise&lt;WakeLockSentinel&gt; request(optional WakeLockType type = "screen");
         };
       </pre>
       <section>