W3cubDocs

/Web APIs

Network Information API

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The Network Information API provides information about the system's connection in terms of general connection type (e.g., 'wifi, 'cellular', etc.). This can be used to select high definition content or low definition content based on the user's connection.

The interface consists of a single NetworkInformation object, an instance of which is returned by the Navigator.connection property.

Note: This feature is available in Web Workers

Interfaces

NetworkInformation

Provides information about the connection a device is using to communicate with the network and provides a means for scripts to be notified if the connection type changes. The NetworkInformation interface cannot be instantiated. It is instead accessed through the Navigator interface.

Examples

Detect connection changes

This example watches for changes to the user's connection.

js

let type = navigator.connection.effectiveType;

function updateConnectionStatus() {
  console.log(
    `Connection type changed from ${type} to ${navigator.connection.effectiveType}`,
  );
  type = navigator.connection.effectiveType;
}

navigator.connection.addEventListener("change", updateConnectionStatus);

Preload large resources

The connection object is useful for deciding whether to preload resources that take large amounts of bandwidth or memory. This example would be called soon after page load to check for a connection type where preloading a video may not be desirable. If a cellular connection is found, then the preloadVideo flag is set to false. For simplicity and clarity, this example only tests for one connection type. A real-world use case would likely use a switch statement or some other method to check all of the possible values of NetworkInformation.type. Regardless of the type value you can get an estimate of connection speed through the NetworkInformation.effectiveType property.

js

let preloadVideo = true;
const connection = navigator.connection;
if (connection) {
  if (connection.effectiveType === "slow-2g") {
    preloadVideo = false;
  }
}

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
Network_Information_API 61 79 31–32 No 48 No 50 38 14–99 37 No 3.0
Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
Network_Information_API 61 79 31–32 No 48 No 50 38 31–99 25 No 3.0
change_event 61 79 No No 48 No 50 38
NoOn Firefox, the event handler property corresponding to the change event is ontypechange.
45 No 3.0
downlink
61The value is never greater than 10 Mbps, as a non-standard anti-fingerprinting measure.
79The value is never greater than 10 Mbps, as a non-standard anti-fingerprinting measure.
No No
48The value is never greater than 10 Mbps, as a non-standard anti-fingerprinting measure.
No
50The value is never greater than 10 Mbps, as a non-standard anti-fingerprinting measure.
38The value is never greater than 10 Mbps, as a non-standard anti-fingerprinting measure.
No
25The value is never greater than 10 Mbps, as a non-standard anti-fingerprinting measure.
No
3.0The value is never greater than 10 Mbps, as a non-standard anti-fingerprinting measure.
downlinkMax
61Only supported in Chrome OS
No No No No No 50 38 No 45 No 3.0
effectiveType 61 79 No No 48 No 50 38 No 45 No 3.0
rtt
61The value is never greater than 3000 ms, as a non-standard anti-fingerprinting measure.
79The value is never greater than 3000 ms, as a non-standard anti-fingerprinting measure.
No No
48The value is never greater than 3000 ms, as a non-standard anti-fingerprinting measure.
No
50The value is never greater than 3000 ms, as a non-standard anti-fingerprinting measure.
38The value is never greater than 3000 ms, as a non-standard anti-fingerprinting measure.
No
25The value is never greater than 3000 ms, as a non-standard anti-fingerprinting measure.
No
3.0The value is never greater than 3000 ms, as a non-standard anti-fingerprinting measure.
saveData 65 79 No No 52 No 65 65 No 47 No 9.0
type
61Only supported in Chrome OS
No 31–32 No No No 50 38 31–99 45 No 3.0
typechange_event No No 31–32 No No No 50
38Removal proposed in bug 699892.
31–99
25Removal proposed in bug 699892.
No
3.0Removal proposed in bug 699892.
worker_support 61 79 31–32 No 48 No 50 38 53–99 45 No 3.0

api.NetworkInformation

BCD tables only load in the browser

api.Navigator.connection

BCD tables only load in the browser

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Network_Information_API