Check-Host API Client

A minimal JavaScript API client for check-host.net, compatible with Node.js and browsers.

Installation

1. Clone the repository:

   git clone https://gitlab.com/colonelpopcorn/check-host.git

2. Install the dependencies:

   npm install

Development

To run the development server, use the following command:

npm run dev

This will start a Vite development server and open the index.html file in your browser.

Building

To build the project for production, use the following command:

npm run build

This will create a dist directory with the bundled and minified files.

Testing

To run the tests, use the following command:

npm test

This will run the tests using Vitest.

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you have any improvements or suggestions.

Library Usage (Node.js)

import { ping, getResult } from 'check-host-api';

async function main() {
  try {
    // Perform a ping check
    const checkResult = await ping('google.com', { max_nodes: 3 });
    console.log('Check started:', checkResult);

    // Wait for a few seconds for the check to complete
    setTimeout(async () => {
      // Get the result
      const result = await getResult(checkResult.request_id);
      console.log('Check result:', result);
    }, 5000); // 5 seconds delay. Adjust as needed.

  } catch (error) {
    console.error('Error:', error.message);
  }
}

main();

Browser Usage

The index.html file is set up to be used with the Vite development server. Simply run npm run dev and open the provided URL in your browser.

CLI Usage

# Perform a ping check
check-host ping google.com --max-nodes 1

# Perform an HTTP check
check-host http google.com

# Get the list of nodes
check-host get-nodes

API

ping(host, [options])

http(host, [options])

tcp(host, [options])

dns(host, [options])

udp(host, [options])

Initiates a check of the specified type.

• host (string, required): The host to check.
• options (object, optional):
  • max_nodes (number): The maximum number of nodes to use for the check.
  • node (string): A specific node to use for the check.

Returns a promise that resolves with the check information, including the request_id.

getResult(requestId)

Retrieves the result of a check.

• requestId (string, required): The ID of the request to get the result for.

Returns a promise that resolves with the check result.

getNodes([type])

Retrieves the list of available nodes.

• type (string, optional): The type of node list to retrieve. Can be 'ips' (default) or 'hosts'.

Returns a promise that resolves with the list of nodes.