UNPKG

1.12 kBMarkdownView Raw
1# reachable-urls
2
3Check URLs are reachable in text.
4
5[![Build Status](https://travis-ci.org/1000ch/reachable-urls.svg?branch=master)](https://travis-ci.org/1000ch/reachable-urls)
6[![NPM version](https://badge.fury.io/js/reachable-urls.svg)](http://badge.fury.io/js/reachable-urls)
7[![Dependency Status](https://david-dm.org/1000ch/reachable-urls.svg)](https://david-dm.org/1000ch/reachable-urls)
8[![devDependency Status](https://david-dm.org/1000ch/reachable-urls/dev-status.svg)](https://david-dm.org/1000ch/reachable-urls#type=dev)
9
10## Install
11
12```bash
13$ npm install --save reachable-urls
14```
15
16## Usage
17
18### CLI
19
20```bash
21Usage
22 $ reachable-urls [<file|glob> ...]
23
24Options
25 --compact Show only not-reachable URLs
26 --help Show help
27 --version Show version
28```
29
30### JavaScript
31
32```javascript
33const reachableUrls = require('reachable-urls');
34console.log(reachableUrls('https://foobarbaz.com https://github.com'));
35
36// {
37// 'https://github.com': true,
38// 'https://foobarbaz.com': false
39// }
40```
41
42## License
43
44[MIT](https://1000ch.mit-license.org) © [Shogo Sensui](https://github.com/1000ch)