|
9 years ago | |
---|---|---|
src | 9 years ago | |
test | 9 years ago | |
.eslintignore | 9 years ago | |
.eslintrc.json | 9 years ago | |
.gitignore | 9 years ago | |
.npmignore | 9 years ago | |
.travis.yml | 9 years ago | |
README.md | 9 years ago | |
package.json | 9 years ago |
README.md
my-name-is-url 
Intelligently finds many different url formats in a string. Works in browser and node.
About
In a nutshell, my-name-is-url
is an Intelligent parser that searches a string of text for urls. The url spec is so vague that almost anything could be 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.
❗️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 search text for urls.
Install
$ npm install --save my-name-is-url
or
$ jspm install npm:my-name-is-url
Usage
Import the module
CommonJS
var Urls = require('my-name-is-url');
ES6
import Urls from 'my-name-is-url';
Regex
If you just wanna do your own thing the regex used internally is helpfully exposed
const UrlRegex = Urls.regex;
Get Urls
The get()
method returns an array of urls in a piece of text
const text = 'Check out these sites: site1.com,site2.com,site3.com';
Urls(text).get(); // Returns:
['site1.com', 'site2.com', 'site3.com']
Filter Urls
The filter()
method runs a filter on each url in a piece of text
const text = 'My GitHub profile: https://github.com/lukechilds';
Urls(text).filter(url => `<a href="${url}">${url}</a>`); // Returns:
'My GitHub profile: <a href="https://github.com/lukechilds">https://github.com/lukechilds</a>'