Nitro Powered Motorcycles

    is-port-reachable
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.0 • Public • Published

    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

    Install

    npm i is-port-reachable

    DownloadsWeekly Downloads

    2,068,731

    Version

    4.0.0

    License

    MIT

    Unpacked Size

    4 kB

    Total Files

    5

    Last publish

    Collaborators

    • sindresorhus
    • silverwind