npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ember-network-state

v2.5.0

Published

Check and react on network state of your progressive web app

Downloads

526

Readme

ember-network-state

Build Status GitHub version NPM version Dependency Status codecov Greenkeeper badge Ember Observer Score FOSSA Status

Information

NPM

  • Ember.js v3.20 or above
  • Ember CLI v3.20 or above
  • Node.js v12 or above

The browser provides network property window.navigator.onLine and events online and offline. The problem is that this API is not reliable, we can have an interface connection (phone is not on airplane mode, we have WiFi data) but the network may not have access to the internet.

In order to confirm the connection status, this addon pings a URL (by default it is the favicon.ico) when it detects that user supposedly have connectivity again. When the ping ends and it goes OK, it will switch to online state, but if ping doesn't go OK, this addon will keep the state limited and it will schedule a ping every certain time.

If the browser has implemented connection API, it will listen for changes on network quality as well.

Below is an example of all states of the service:

States

Usage

Install the addon with ember-cli.

ember install ember-network-state

Inject the service in your app:

export default class MyClass {
  @service network;
}

Interface

Properties

  • state: returns current state of the network. Possible values: ONLINE, OFFLINE and LIMITED. You can import values from: import { STATES } from 'ember-network-state/constants';

  • remaining: returns remaining milliseconds to next reconnect.

  • isOnline: computed value from state that returns when is ONLINE.

  • isOffline: computed value from state that returns when is OFFLINE.

  • isLimited: computed value from state that returns when is LIMITED.

  • isReconnecting: checks when service is testing for connection.

  • hasTimer: checks when service has scheduled a timer.

  • lastReconnectDuration: saves last reconnect duration.

  • lastReconnectStatus: saves last reconnect status.

Methods

  • reconnect: you can call this method to force a reconnect request. Next delay will be multiplied as if it will reach countdown to zero.

Events

You can subscribe to the change event to receive changes on state property.

const network = this.get('network');

network.on('change', (state) => {});

Configuration

The addon can be configured in config/environment.js of your app.

module.exports = function (/* environment */) {
  return {
    'network-state': {
      reconnect: {
        auto: true,
        path: '/favicon.ico',
        delay: 5000,
        multiplier: 1.5,
        timeout: 15000,
        maxDelay: 60000,
        maxTimes: -1,
      },
    },
  };
};

Posible values:

  • reconnect: Object to configure reconnect parameters.
    • auto: Auto reconnects when network changes.
    • path: Path to request on reconnect. Default: /favicon.ico.
    • delay: Initial delay for retry a reconnection. Default: 5000.
    • multiplier: Increment for next retry. Next delay will be delay * multiplier. Default: 1.5.
    • timeout: Reconnect request timeout.
    • maxDelay: Maximum delay for a reconnect. Default: 60000.
    • maxTimes: Maximum times for a reconnect. When value is negative, its Infinity. Default: -1.

Contribute

If you want to contribute to this addon, please read the CONTRIBUTING.md.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See the list of contributors who participated in this project.

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

FOSSA Status