aboutsummaryrefslogtreecommitdiff
path: root/node_modules/isurl/README.md
blob: 6903ac709adae4a0ddf31adcf4acd06d8f84ec72 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# isurl [![NPM Version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]

> Checks whether a value is a WHATWG [`URL`](https://developer.mozilla.org/en/docs/Web/API/URL).


Works cross-realm/iframe and despite @@toStringTag.


## Installation

[Node.js](http://nodejs.org/) `>= 4` is required. To install, type this at the command line:
```shell
npm install isurl
```


## Usage

```js
const isURL = require('isurl');

isURL('http://domain/');  //-> false
isURL(new URL('http://domain/'));  //-> true
```

Optionally, acceptance can be extended to incomplete `URL` implementations that lack `searchParams` (which are common in many modern web browsers):
```js
const url = new URL('http://domain/?query');

console.log(url.searchParams);  //-> undefined

isURL.lenient(url);  //-> true
```


[npm-image]: https://img.shields.io/npm/v/isurl.svg
[npm-url]: https://npmjs.org/package/isurl
[travis-image]: https://img.shields.io/travis/stevenvachon/isurl.svg
[travis-url]: https://travis-ci.org/stevenvachon/isurl