my-name-is-url  

Intelligently recognises many different url formats in a string. For the browser and node. Here, have a play.

About

my-name-is-url was created because I couldn't find a parser with a high enough success rate. The url spec is so vague that many strings _could_ be a url, therefore matching the spec directly results in a lot of false positives. Most parsers get around this by requiring a url to contain a scheme to be matched as a url.

The regular expression used in my-name-is-url tries to match patterns likely to represent a url in a sentence rather than matching the actual url spec. This results in a much wider scope of matchable urls than most other parsers without introducing loads of false positives.

> ❗️Important note
>
> If you're trying to parse a url into sections (scheme,host) or check a url is valid this module isn't for you. This module is intended to find urls in a string.

Install

``shell
npm install --save my-name-is-url
`

or

`shell
jspm install my-name-is-url
`

Usage

`js
import Urls from 'my-name-is-url';

const getText = 'Check out these sites: foobar.com,//foo.ninja,http://bar.com.';
Urls(getText).get();
// [ 'foobar.com', '//foo.ninja', 'http://bar.com' ]

const filterText = 'My GitHub profile: https://github.com/lukechilds';
Urls(filterText).filter(url => ${url});
// 'My GitHub profile: https://github.com/lukechilds'
`

$3

CommonJS

`js
var Urls = require('my-name-is-url');
`

ES6

`js
import Urls from 'my-name-is-url';
`

$3

If you just wanna do your own thing the regex used internally is helpfully exposed.

`js
var urlRegex = require('my-name-is-url').regex;
`

or

`js
import { regex as urlRegex } from 'my-name-is-url';
`

API

$3

The regex used internally for matching urls.

$3

Returns an array of url matches. If there are no matches an empty array will be returned.

`js
const text = 'Check out these sites: foobar.com,//foo.ninja,http://bar.com.';

Urls(text).get();
// [ 'foobar.com', '//foo.ninja', 'http://bar.com' ]
`

$3

Runs a filter callback on each url in a string.

#### cb

Required

Type: function

`js
const text = 'My GitHub profile: https://github.com/lukechilds';

Urls(text).filter(url => ${url});
// 'My GitHub profile: https://github.com/lukechilds'
`

> 👍 Pro tip
>
> You can get a parser instance by calling Urls() or new Urls`, whichever you prefer.

License

MIT © Luke Childs