https://github.com/sindresorhus/is-reachable

Check if servers are reachable
https://github.com/sindresorhus/is-reachable

browser connectivity detect internet network nodejs online ping reachability

Last synced: about 1 month ago
JSON representation

Check if servers are reachable

• Host: GitHub
• URL: https://github.com/sindresorhus/is-reachable
• Owner: sindresorhus
• License: mit
• Created: 2015-06-25T21:42:16.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2023-10-30T15:50:34.000Z (about 1 year ago)
• Last Synced: 2024-04-13T21:26:23.089Z (7 months ago)
• Topics: browser, connectivity, detect, internet, network, nodejs, online, ping, reachability
• Language: JavaScript
• Size: 87.9 KB
• Stars: 372
• Watchers: 12
• Forks: 40
• Open Issues: 12
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome - sindresorhus/is-reachable - Check if servers are reachable (nodejs)

README

        
# is-reachable

> Check if servers are reachable

Works in Node.js and the browser *(with a bundler)*.

The Node.js version will do a TCP handshake with the target's port. It attempts to detect cases where a router redirects the request to itself.

The browser version is limited by the fact that browsers cannot connect to arbitrary ports. It only supports HTTP and HTTPS and the check relies on the `/favicon.ico` path being present.

## Install

```

$ npm install is-reachable

```

## Usage

```js

const isReachable = require('is-reachable');

(async () => {

	console.log(await isReachable('sindresorhus.com'));

	//=> true

	console.log(await isReachable('google.com:443'));

	//=> true

})();

```

## API

### isReachable(targets, options?)

Returns a `Promise` which is `true` if any of the `targets` are reachable.

#### targets

Type: `string | string[]`

One or more targets to check. Can either be `hostname:port`, a URL like `https://hostname:port` or even just `hostname`. `port` must be specified if protocol is not `http:` or `https:` and defaults to `443`. Protocols other than `http:` and `https:` are not supported.

#### options

Type: `object`

##### timeout

Type: `number`\

Default: `5000`

Timeout in milliseconds after which a request is considered failed.

*Node.js only*

## Related

- [is-online](https://github.com/sindresorhus/is-online) - Check if the internet connection is up

## Maintainers

- [Sindre Sorhus](https://github.com/sindresorhus)

- [silverwind](https://github.com/silverwind)