@karinjs/geturls
v1.0.2
Published
Get all URLs in a string
Downloads
4
Maintainers
Readme
GetUrls
Get all URLs in a string
The URLs will be normalized.
Do not use this for any kind of security-related validation.
Please note the known limitation. You can work around this by setting requireSchemeOrWww
to true
.
Install
npm install @karinjs/geturls
Usage
import GetUrls from '@karinjs/geturls';
const text = 'Lorem ipsum dolor sit amet, //sindresorhus.com consectetuer adipiscing http://yeoman.io elit.';
GetUrls.getUrls(text);
//=> ['http://sindresorhus.com', 'http://yeoman.io']
API
text
Type: string
options
Type: object
All the normalize-url
options in addition to:
extractFromQueryString
Type: boolean
Default: false
Extract URLs that appear as query parameters in the found URLs.
exclude
Type: string[]
Default: []
Exclude URLs that match URLs in the given array.
requireSchemeOrWww
Type: boolean
Default: false
Require URLs to have a scheme or leading www.
to be considered an URL. When false
, matches against a list of valid TLDs, so it will match URLs like unicorn.education
.
Does not affect URLs in query parameters if using the extractFromQueryString
option.
Related
- get-urls-cli - CLI for this module
- linkify-urls - Linkify URLs in text