The getHighEntropyValues()
method of the NavigatorUAData
interface is a Promise
that resolves with a dictionary object containing the high entropy values the user-agent returns.
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, and unlikely to identify a user. The values returned by NavigatorUAData.getHighEntropyValues()
could potentially reveal more information. These values are therefore retrieved via a Promise
, allowing time for the browser to request user permission, or make other checks.
getHighEntropyValues(hints)
A Promise
that resolves to an object containing some or all of the following values (based on the hints requested):
brands
-
Returns an array of objects containing brand
and version
specifying the browser brand and its version (the same information as provided by NavigatorUAData.brands
). Note that this information can be sent to a server in the Sec-CH-UA
header (a low-entropy client hint).
mobile
-
Returns true
if the user agent is running on a mobile device (the same information as provided by NavigatorUAData.mobile
). Note that this information can be sent to a server in the Sec-CH-UA-Mobile
header (a low-entropy client hint).
platform
-
Returns a string describing the platform the user agent is running on, like "Windows"
(the same information as provided by NavigatorUAData.platform
). Note that this information can be sent to a server in the Sec-CH-UA-Platform
header (a low-entropy client hint).
architecture
-
A string containing the platform architecture. For example, "x86"
. Note that this information can be sent to a server in the Sec-CH-UA-Arch
header after the server explicitly requests it in the Accept-CH
header.
bitness
-
A string containing the architecture bitness. For example, "32"
or "64"
. Note that this information can be sent to a server in the Sec-CH-UA-Bitness
header if the server explicitly requests it in the Accept-CH
header.
model
-
A string containing the model of mobile device. For example, "Pixel 2XL"
. If device is not a mobile device or if device model is not known, model
will be ""
. Note that this information can be sent to a server in the Sec-CH-UA-Model
header if the server explicitly requests it in the Accept-CH
header.
platformVersion
-
A string containing the platform version. Platform name itself is always available as low-entropy hint platform
. For example, "10.0"
. Note that this information can be sent to a server in the Sec-CH-UA-Platform-Version
header if the server explicitly requests it in the Accept-CH
header.
-
uaFullVersion
Deprecated
-
A string containing the full browser version. For example, "103.0.5060.134"
. Deprecated in favor of fullVersionList
. Note that this information can be sent to a server in the Sec-CH-UA-Full-Version
header if the server explicitly requests it in the Accept-CH
header.
fullVersionList
-
An array of objects with properties "brand"
and "version"
representing the browser name and full version respectively. For example, {"brand": "Google Chrome", "version": "103.0.5060.134"}, {"brand": "Chromium", "version": "103.0.5060.134"}
. Please note that one object may intentionally contain invalid information to prevent sites from relying on a fixed list of browsers. Note that this information can be sent to a server in the Sec-CH-UA-Full-Version-List
header if the server explicitly requests it in the Accept-CH
header.
In the following example a number of hints are requested using the getHighEntropyValues()
method. When the promise resolves, this information is printed to the console.
navigator.userAgentData
.getHighEntropyValues([
"architecture",
"model",
"platformVersion",
"fullVersionList",
])
.then((values) => console.log(values));