is-port-reachable

Check if a local or remote port is reachable


Keywords
port, reachable, local, remote, host, ip, localhost, address, connect, connectable, online, socket, tcp, is, check
License
MIT
Install
npm install is-port-reachable@3.0.0

Documentation

is-port-reachable Build Status

Check if a local or remote port is reachable

Install

$ npm install is-port-reachable

Usage

const isPortReachable = require('is-port-reachable');

(async () => {
	console.log(await isPortReachable(80, {host: 'google.com'}));
	//=> true
})();

API

isPortReachable(port, options?)

Returns Promise<boolean>.

port

Type: number

options

Type: object

host

Type: string
Default: 'localhost'

Can be a domain or an IP.

timeout

Type: number
Default: 1000

Milliseconds to wait before giving up.

Related