readme.md

thoward37@gmail.com/push-test2-1791933121043 / readme.md @ fe5b370d Download

Ladder Summary

file The file is the README for the **`is-up`** npm package. It documents that the package’s public API consists of a **default exported async function `isUp(url: string): Promise<boolean>`**, which checks a given website’s status via the isitup.org API and resolves to `true` if the site is up and `false` otherwise. No classes are exported.

# is-up

> Check whether a website is up or down using the [isitup.org](https://isitup.org) API

## Install

```sh
npm install is-up
```

## Usage

```js
import isUp from 'is-up';

console.log(await isUp('https://sindresorhus.com'));
//=> true
```

## Related

- [is-up-cli](https://github.com/sindresorhus/is-up-cli) - CLI for this module