aboutsummaryrefslogtreecommitdiff
path: root/node_modules/isurl/README.md
diff options
context:
space:
mode:
authorMinteck <nekostarfan@gmail.com>2021-08-24 14:41:48 +0200
committerMinteck <nekostarfan@gmail.com>2021-08-24 14:41:48 +0200
commitd25e11bee6ca5ca523884da132d18e1400e077b9 (patch)
tree8af39fde19f7ed640a60fb397c7edd647dff1c4c /node_modules/isurl/README.md
downloadkartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.tar.gz
kartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.tar.bz2
kartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.zip
Initial commit
Diffstat (limited to 'node_modules/isurl/README.md')
-rw-r--r--node_modules/isurl/README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/node_modules/isurl/README.md b/node_modules/isurl/README.md
new file mode 100644
index 0000000..6903ac7
--- /dev/null
+++ b/node_modules/isurl/README.md
@@ -0,0 +1,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