Code Monkey home page Code Monkey logo

connection's Introduction

ES6 Boilerplate

Just change the name of the library in the package.json. That's it. The package name variable will be the entry point for the library in browser case. You can change this behaviour here tools/webpack.config.base.js the library field. Develop and enjoy.

Write a library in ES6

  • webpack for bundling, exporting in UMD (with the name of the package in browser case), support for process.env in source code
  • babel, of course
  • eslint (airbnb + valid-jsdoc)
  • jasmine for test with mocha reporter
  • documentation automagically generated

Commands

  • git clone && rm .git && git init
  • npm run build // generate dist/<package.name>.js, dist/<package.name>.min.js, dist/<package.name>.min.js.map
  • npm run test
  • npm run test:watch // run tests while typing
  • npm run documentation // generate docs folder with .html, append docs to the readme.md

Release a new version

  • npm version patch|minor|major This will generate the docs/ and dist/ so you can have the build version committed for that tag

API

NetworkInfo

Connection module. A simple module to check if connectivity is on or off Usage:

Examples

Connection.initialize();
const Listener = ({networkState, type}) => {console.log(networkState, type); }
Connection.addListener(Listener);
Connection.removeListener(Listener); 
Connection.hostReachable(url?); //sync call to the current domain

initialize

bind listeners to online|offline events if it runs in cordova context must be called after deviceready and cordova-plugin-network should be installed

checkConnection

checkConnection

Returns object connectionStatus

Returns string connectionStatus.type online|offline

Returns string connectionStatus.networkState 'none', 'wifi', 3G, 4G

addListener

Register a function to be called on connection change

Parameters

  • listener function the listener to register

removeListener

UnRegister a function

Parameters

  • listener function the listener to unregister

hostReachable

Host reachable make a simple sync HEAD request to location.hostname or custom url with a param to disable the cache

Parameters

  • url [string] simple url to call without querystring (optional, default window.location.hostname)

Returns boolean

connectionStatus

type {object}

UNSUPPORTED

type {boolean}

connection's People

Watchers

Gianni Fiorentini avatar James Cloos avatar Francesco Belli avatar Lorenzo Mussi avatar Aurelio Merenda avatar Pasquale Mangialavori avatar  avatar

connection's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.