is-port-reachable

Check if a local or remote port is reachable

Usage no npm install needed!

<script type="module">
  import isPortReachable from 'https://cdn.skypack.dev/is-port-reachable';
</script>

README

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