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 entire API consists of the addition of the NetworkInformation interface and a single property to the Navigator interface: Navigator.connection.

Note: This feature is available in Web Workers.

Examples

Detect connection changes

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

var connection = navigator.connection || navigator.mozConnection || navigator.webkitConnection;
var type = connection.type;

function updateConnectionStatus() {
  console.log("Connection type changed from " + type + " to " + connection.type);
}

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.

let preloadVideo = true;
var connection = navigator.connection || navigator.mozConnection || navigator.webkitConnection;
if (connection) {
  if (connection.type === 'cellular') {
    preloadVideo = false;
  }
}

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 interfaces cannot be instantiated. It is instead accessed through the Navigator interface.

Specifications

Specification Status Comment
Network Information API
The definition of 'Network Information API' in that specification.
Draft Initial specification

Browser compatibility

NetworkInformation

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic support
Experimental
Chrome Full support 61Edge No support NoFirefox No support NoIE No support NoOpera Full support 48Safari No support NoWebView Android Full support 50Chrome Android Full support 38Edge Mobile ? Firefox Android Full support 31Opera Android Full support 37Safari iOS No support NoSamsung Internet Android ?
Available in workers
Experimental
Chrome Full support 61Edge No support NoFirefox No support NoIE ? Opera Full support 48Safari ? WebView Android Full support 50Chrome Android Full support 38Edge Mobile ? Firefox Android Full support 53Opera Android Full support 37Safari iOS ? Samsung Internet Android ?
downlink
Experimental
Chrome Full support 61Edge No support NoFirefox No support NoIE ? Opera Full support 48Safari ? WebView Android Full support 50Chrome Android Full support 38Edge Mobile ? Firefox Android ? Opera Android Full support 37Safari iOS ? Samsung Internet Android ?
downlinkMax
Experimental
Chrome Full support 61Edge No support NoFirefox No support NoIE No support NoOpera Full support 48Safari No support NoWebView Android Full support 50Chrome Android Full support 38Edge Mobile ? Firefox Android No support NoOpera Android Full support 37Safari iOS No support NoSamsung Internet Android ?
effectiveType
Experimental
Chrome Full support 61Edge No support NoFirefox No support NoIE No support NoOpera Full support 48Safari No support NoWebView Android Full support 50Chrome Android Full support 38Edge Mobile ? Firefox Android Full support YesOpera Android Full support 37Safari iOS ? Samsung Internet Android ?
onchange
Experimental
Chrome Full support 61Edge No support NoFirefox No support NoIE No support NoOpera Full support 48Safari No support NoWebView Android Full support 50Chrome Android Full support 38Edge Mobile ? Firefox Android No support No
Notes
No support No
Notes
Notes On Firefox, the event handler property corresponding to the change event is ontypechange.
Opera Android Full support 37Safari iOS No support NoSamsung Internet Android ?
rtt
Experimental
Chrome Full support 61Edge No support NoFirefox No support NoIE No support NoOpera Full support 48Safari No support NoWebView Android Full support 50Chrome Android Full support 38Edge Mobile ? Firefox Android No support NoOpera Android Full support 37Safari iOS No support NoSamsung Internet Android ?
type
Experimental
Chrome Full support 61Edge No support NoFirefox No support NoIE No support NoOpera Full support 48Safari No support NoWebView Android Full support 50Chrome Android Full support 38Edge Mobile ? Firefox Android No support NoOpera Android Full support 37Safari iOS No support NoSamsung Internet Android ?

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
See implementation notes.
See implementation notes.

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic support
Experimental
Chrome Full support 61Edge ? Firefox ? IE No support NoOpera ? Safari No support NoWebView Android Full support 50Chrome Android Full support 38Edge Mobile ? Firefox Android Full support 14
Notes
Full support 14
Notes
Notes The Network API is enabled by default. Can be disabled using the dom.netinfo.enabled preference.
Opera Android Full support 37Safari iOS No support NoSamsung Internet Android ?

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
See implementation notes.
See implementation notes.

See also

Document Tags and Contributors

Last updated by: fscholz,