Need help with pingjs?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

jdfreder
234 Stars 85 Forks BSD 3-Clause "New" or "Revised" License 12 Commits 8 Opened issues

Description

JavaScript client side ping API.

Services available

!
?

Need anything else?

Contributors list

# 13,959
Python
jupyter
React
repl
9 commits

pingjs

JavaScript ping API for use in a web browser context. Released under the BSD-3-Clause license, see LICENSE.

Installation

There are three possible ways to install this.

HTML script tag

Drag and drop the ping.js file next to an HTML file. Inside the

 tag 
of the HTML file, use a script tag to load ping.js.  

NPM

npm install --save web-pingjs

YARN

yarn add web-pingjs

Bower

bower install --save web-pingjs

Usage

This library uses a UMD header that allows it to be loaded as CommonJS, AMD, or a window global object.

A single function is exported,

ping
. Ping's signature follows:
/**
 * Pings a url.
 * @param  {String} url
 * @param  {Number} multiplier - optional, factor to adjust the ping by.  0.3 works well for HTTP servers.
 * @return {Promise} promise that resolves to a ping (ms, float).
 */

Example:

ping('https://google.com/').then(function(delta) {
    console.log('Ping time was ' + String(delta) + ' ms');
}).catch(function(err) {
    console.error('Could not ping remote URL', err);
});

Caveats

The user should be aware that this method relies on the HTTP protocol to ping remote URLs. Consequently, ping times are not as reliable as if they were performed using the ICMP protocol.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.