https://github.com/ganapativs/netinfo

Get network connection details of device in browser.
https://github.com/ganapativs/netinfo

browser connection-speed connection-type download-speed internet-info netinfo

Last synced: 12 days ago
JSON representation

Get network connection details of device in browser.

• Host: GitHub
• URL: https://github.com/ganapativs/netinfo
• Owner: ganapativs
• License: mit
• Created: 2017-10-24T16:09:57.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-26T18:36:55.000Z (about 7 years ago)
• Last Synced: 2025-01-04T19:07:32.336Z (16 days ago)
• Topics: browser, connection-speed, connection-type, download-speed, internet-info, netinfo
• Language: JavaScript
• Homepage:
• Size: 45.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# netinfo

Get network connection details of device in browser using navigator.connection API.

 

This package uses [Expanded Network API](https://wicg.github.io/netinfo/) and currently supported in latest version of chrome. 

[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)

[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/ganapativs/netInfo/)

[![Dependency Status](https://david-dm.org/netinfo/badges.svg)](https://david-dm.org/netinfo/badges)

[![devDependency Status](https://david-dm.org/netinfo/badges/dev-status.svg)](https://david-dm.org/netinfo/badges#info=devDependencies)

[![npm version](https://badge.fury.io/js/netinfo.svg)](https://badge.fury.io/js/netinfo)

[![GitHub version](https://badge.fury.io/gh/ganapativs%2Fnetinfo.svg)](https://badge.fury.io/gh/ganapativs%2Fnetinfo)

[![Bower version](https://badge.fury.io/bo/netinfo.svg)](https://badge.fury.io/bo/netinfo)

# Installation

- NPM

```sh

npm install netinfo

```

- Yarn

```sh

yarn add netinfo

```

## Usage

```javascript

import getNetInfo from 'netinfo';

// Other options ;)

// let getNetInfo = require('netinfo');

// 

/** 

* Calling `getNetInfo()` returns current network connection details of device as object

* {

*   downlink: 6.4,

*   downlinkMax: Infinity,

*   effectiveType: "4g",

*   rtt: 350,

*   type: "wifi"

* }

*/

const currentNetInfo = getNetInfo();

// Optionally you can listen to net info changes

// This callback will be called when there is change in net info

let onNetInfoChange = (newNetInfo) => {

    // Do something here

};

currentNetInfo.addChangeListener(onNetInfoChange);

// Somewhere later in code, Remove net info change listener callback

currentNetInfo.removeChangeListener(onNetInfoChange);

```

## License

MIT © [Ganapati V S](http://meetguns.com)

[![forthebadge](http://forthebadge.com/badges/uses-js.svg)](http://forthebadge.com)

[![forthebadge](http://forthebadge.com/badges/kinda-sfw.svg)](http://forthebadge.com)