Luke Childs ada56373b7 Comment out return value in docs		9 years ago
src	Add support for .local and .dev TLDs	9 years ago
test	Add grab tests	9 years ago
.DS_Store	Typo in docs	9 years ago
.codeclimate.yml	Disable line length check for markdown	9 years ago
.eslintignore	Setup project	9 years ago
.eslintrc.json	Setup project	9 years ago
.gitignore	Change test coverage to coveralls	9 years ago
.npmignore	Setup project	9 years ago
.travis.yml	Change test coverage to coveralls	9 years ago
README.md	Comment out return value in docs	9 years ago
package.json	Test Code Climate test coverage too	9 years ago

README.md

my-name-is-url

Intelligently finds many different url formats in a string. For the 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 find urls in a string.

Install

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

jspm install npm:my-name-is-url

Usage

Importing

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 string

const text = 'Check out these sites: site1.com,site2.com,site3.com';

Urls(text).get();
// ['site1.com', 'site2.com', 'site3.com']

Filter Urls

The filter() method runs a filter on each url in a string

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

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

Pro tip

You can get a parser instance by calling Urls() or new Urls, whichever you prefer.