JavaScript Battery API: Promises

By  on  

Working at Mozilla has afforded me the time to look at new APIs, one of them being the Battery API.  I wrote about the Battery API a while back, when the API was fresh into browsers.  Since then the Battery API has changed, implementing a promise-based API which is now available only in Google Chrome.  Let's have a look at how to use the new API!

The functionality we need is still hosted on the navigator object, but this time it's a function called getBattery:

navigator.getBattery().then(function(result) {});

A promise is returned from the getBattery() call, and the callback provided to then is given a BatteryManager object which provides the following example information:

// result:
BatteryManagery {
	charging: false,
	chargingTime: Infinity,
	dischargingTime: 8940,
	level: 0.59,
	onchargingchange: null,
	onchargingtimechange: null,
	ondischargingtimechange: null,
	onlevelchange: null
}

The new API is different in execution but likewise in result. Remember that the old API had issues with Mac device batteries, and that doesn't seem to have changed.  Accommodating for different browser prefixes is a pain but something we've come to accept, but it really sucks when the methodology is completely different.  Let's hope that other browser vendors are quick to update and we can see a unified, browser-prefixed (banter) API again.

Recent Features

  • By
    Camera and Video Control with HTML5

    Client-side APIs on mobile and desktop devices are quickly providing the same APIs.  Of course our mobile devices got access to some of these APIs first, but those APIs are slowly making their way to the desktop.  One of those APIs is the getUserMedia API...

  • By
    CSS Filters

    CSS filter support recently landed within WebKit nightlies. CSS filters provide a method for modifying the rendering of a basic DOM element, image, or video. CSS filters allow for blurring, warping, and modifying the color intensity of elements. Let's have...

Incredible Demos

  • By
    Simple Image Lazy Load and Fade

    One of the quickest and easiest website performance optimizations is decreasing image loading.  That means a variety of things, including minifying images with tools like ImageOptim and TinyPNG, using data URIs and sprites, and lazy loading images.  It's a bit jarring when you're lazy loading images and they just...

  • By
    CSS Fixed Positioning

    When you want to keep an element in the same spot in the viewport no matter where on the page the user is, CSS's fixed-positioning functionality is what you need. The CSS Above we set our element 2% from both the top and right hand side of the...

Discussion

  1. MaxArt

    Wow, yeah, promises are pretty cool, awesome!

    … No, not really in this case.

    Previously we could retrieve all those properties synchronously. May I guess the change has been made because it’s not always possible to get the value synchronously? I hope we’re not making everything asynchronous just for the sake of it.

    Another slightly related thing is the method’s name: getBattery. When I want to get something, I want it “right here, right now”. Synchronously. If it’s asynchronous, if I’m getting a promise that can fail, then I’m making a *request*. A better name would have been queryBattery or inspectBattery, then.

    • I mostly agree. I think the idea is that an ideal world makes everything asynchronous, but why the Battery API needs to be Promised-based is beyond me. But I’m sure people smarter than us know why :)

    • MaxArt

      A lot of new things in Javascript is getting this asynchronous nature. It’s the new trend. Most of the times it’s a *good* thing indeed. But now I’m thinking about older stuff and how it could have been conceived today. For example:

      // Callback as the second argument
      document.querySelector("#myElement", function(result) {
          // Promise-style
          result.queryComputedStyle().then(function(style) {
              ...
          });
      });
      

      Just… wow. I wonder if with all the experience we have today the DOM could have been something better than the current utter mess.

  2. Amazing. Thanks

  3. Drew

    It’s probably possible to normalize the functionality a bit by taking the non-promise based apis and converting them into promises in whatever function is normalizing all the browser prefix versions.

  4. Jas

    I apologize for necroing, I just wanted to point out that getting battery data requires an external call which means that we’re at the mercy of whatever that external call does and if getBattery() is synchronous, and for whatever reason takes longer than expected to complete, we have now blocked the main javascript thread -> frozen web page.

    Whenever we want to make an external call, i.e. database, web api, get battery info, anything that is not within the context of a web browser…etc., we should be making that call asynchronously.

    Now, since we have to make asynchronous calls, promises is currently the best way to handle them. I really don’t think anyone of us wants to go back to the days of callback hell (not to be confused with promises, which MaxArt seems to have done).

Wrap your code in <pre class="{language}"></pre> tags, link to a GitHub gist, JSFiddle fiddle, or CodePen pen to embed!