MDN self-hosted library · e01.org

NavigatorUAData

User-Agent Client Hints API

User-Agent Client Hints API

The NavigatorUAData interface of the returns information about the browser and operating system of a user.

An instance of this object is returned by calling Navigator.userAgentData or WorkerNavigator.userAgentData. Therefore, this interface has no constructor.

[!NOTE] The terms high entropy and low entropy refer to the amount of information these values reveal about the browser. The values returned as properties are deemed low entropy, which are unlikely to identify a user. The NavigatorUAData.getHighEntropyValues() can be used to request additional high entropy values, which could potentially reveal more identifying information. These values are therefore retrieved via a Promise, allowing time for the browser to request user permission, or make other checks.

Instance properties

  • NavigatorUAData.brands
  • : Returns an array of brand information containing the browser name and version.
  • NavigatorUAData.mobile
  • : Returns true if the user-agent is running on a mobile device.
  • NavigatorUAData.platform
  • : Returns the platform brand the user-agent is running on.

Instance methods

  • NavigatorUAData.getHighEntropyValues()
  • : Returns a Promise that resolves with a dictionary object containing low entropy information and requested high entropy information about the browser.
  • NavigatorUAData.toJSON()
  • : Returns a JSON-serializable plain object representing the NavigatorUAData object. Automatically called by JSON.stringify().

Examples

Getting the brands

The following example prints the value of NavigatorUAData.brands to the console.

console.log(navigator.userAgentData.brands);

Returning high entropy values

In the following value a number of hints are requested using the NavigatorUAData.getHighEntropyValues() method. When the promise resolves, this information is printed to the console.

navigator.userAgentData
  .getHighEntropyValues([
    "architecture",
    "model",
    "platform",
    "platformVersion",
    "fullVersionList",
  ])
  .then((ua) => {
    console.log(ua);
  });

Specifications

Browser compatibility

See also