https://github.com/kikobeats/reachable-url

Given an URL, it resolves as fast as possible, performing a GET without downloading the body.
https://github.com/kikobeats/reachable-url

ping reachability reachable url

Last synced: 17 days ago
JSON representation

Given an URL, it resolves as fast as possible, performing a GET without downloading the body.

• Host: GitHub
• URL: https://github.com/kikobeats/reachable-url
• Owner: Kikobeats
• License: mit
• Created: 2018-05-01T22:04:49.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-12-04T20:03:33.000Z (5 months ago)
• Last Synced: 2025-04-02T06:36:39.408Z (24 days ago)
• Topics: ping, reachability, reachable, url
• Language: JavaScript
• Homepage:
• Size: 218 KB
• Stars: 42
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# reachable-url

![Last version](https://img.shields.io/github/tag/Kikobeats/reachable-url.svg?style=flat-square)

[![Coverage Status](https://img.shields.io/coveralls/Kikobeats/reachable-url.svg?style=flat-square)](https://coveralls.io/github/Kikobeats/reachable-url)

[![NPM Status](https://img.shields.io/npm/dm/reachable-url.svg?style=flat-square)](https://www.npmjs.org/package/reachable-url)

> Given an URL, it resolves as fast as possible, performing a GET without downloading the body.

## Install

```bash

$ npm install reachable-url --save

```

## Usage

```js

const reachableUrl = require('reachable-url')

reachableUrl.isReachable(await reachableUrl('https://google.com')) // => true

```

## API

### reachableUrl(input, [options])

#### url

*Required*


Type: `string`

The target URL to be resolved.

#### options

Same as [got#options](https://github.com/sindresorhus/got#goturl-options)

## License

**reachable-url** © [Kiko Beats](https://kikobeats.com), released under the [MIT](https://github.com/Kikobeats/reachable-url/blob/master/LICENSE.md) License.


Authored and maintained by Kiko Beats with help from [contributors](https://github.com/Kikobeats/reachable-url/contributors).

> [kikobeats.com](https://kikobeats.com) · GitHub [Kiko Beats](https://github.com/Kikobeats) · X [@Kikobeats](https://x.com/Kikobeats)