runtime.getPlatformInfo()

Returns information about the current platform. This can only be called in the background script context.

This is an asynchronous function that returns a Promise.

Syntax

js
let getting = browser.runtime.getPlatformInfo()

Parameters

None.

Return value

A Promise that will be fulfilled with a runtime.PlatformInfo value representing the current platform.

Browser compatibility

BCD tables only load in the browser

Examples

Get and log the platform OS:

js
function gotPlatformInfo(info) {
  console.log(info.os);
}

let gettingInfo = browser.runtime.getPlatformInfo();
gettingInfo.then(gotPlatformInfo);

Note: This API is based on Chromium's chrome.runtime API. This documentation is derived from runtime.json in the Chromium code.