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@2.0.1

Documentation

is-port-reachable

Check if a local or remote port is reachable

Install

npm install is-port-reachable

Usage

import isPortReachable from 'is-port-reachable';

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

API

isPortReachable(options)

Returns Promise<boolean> for whether the port is reachable.

port

Type: number

The port to check.

options

Type: object

host

Required
Type: string
Example: 'localhost'

The host to check.

Can be a domain (optionally, with a sub-domain) or an IP address.

timeout

Type: number
Default: 1000

The time to wait in milliseconds before giving up.

Related