40 lines
1.0 KiB
Markdown
40 lines
1.0 KiB
Markdown
|
# 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
|