Nephrite Power Mace

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

    5.2.1 • Public • Published

    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

    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<boolean> 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 - Check if the internet connection is up

    Maintainers

    Install

    npm i is-reachable

    DownloadsWeekly Downloads

    120,344

    Version

    5.2.1

    License

    MIT

    Unpacked Size

    7.34 kB

    Total Files

    6

    Last publish

    Collaborators

    • sindresorhus
    • silverwind