use-network-api
TypeScript icon, indicating that this package has built-in type declarations

2.0.1 • Public • Published

use-network-api

NPM version NPM Weekly Downloads License

A simple JavaScript utility to access the network api.

Install with npm, or Yarn:

# via npm
npm install use-network-api

# or Yarn (note that it will automatically save the package to your `dependencies` in `package.json`)
yarn add use-network-api

Usage with React.js

import { useNetworkApi } from "use-network-api";

function App() {
  const { getBrowser, connection, isOnline } = useNetworkApi();
  return (
    <div>
      <p>Browser: {getBrowser()}</p>
      <p>IsOnline: {isOnline() ? 'Yes' : 'No'}</p>
      <p>Connection Type: {connection?.effectiveType}</p>
    </div>
  );
}

export default App;

Call a function for when the browser does not support the feature

import { useNetworkApi } from "use-network-api";

const handleBrowserNotSupport = () => {
  alert('Not support :(')
}

function App() {  
  const { getBrowser, connection, isOnline } = useNetworkApi(handleBrowserNotSupport);
  
  return (
    <div>
      <p>Browser: {getBrowser()}</p>
      <p>IsOnline: {isOnline() ? 'Yes' : 'No'}</p>
      <p>Connection Type: {connection?.effectiveType}</p>
    </div>
  );
}

export default App;

Readme

Keywords

none

Package Sidebar

Install

npm i use-network-api

Weekly Downloads

1

Version

2.0.1

License

MIT

Unpacked Size

10.4 kB

Total Files

7

Last publish

Collaborators

  • leoavelino7