index.d.ts

import {Options as NormalizeUrlOptions} from 'normalize-url';

declare namespace getUrls {
	interface Options extends NormalizeUrlOptions {
		/**
		Extract URLs that appear as query parameters in the found URLs.

		@default false
		*/
		readonly extractFromQueryString?: boolean;

		/**
		Exclude URLs that match URLs in the given array.

		@default []
		*/
		readonly exclude?: string[];

		/**
		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.

		@default false
		*/
		readonly requireSchemeOrWww?: boolean;
	}
}

/**
Get all URLs in a string.

The URLs will be [normalized](https://github.com/sindresorhus/normalize-url).

@returns A `Set` of URLs.

@example
```
import getUrls = require('get-urls');

const text = 'Lorem ipsum dolor sit amet, //sindresorhus.com consectetuer adipiscing http://yeoman.io elit.';

getUrls(text);
//=> Set {'http://sindresorhus.com', 'http://yeoman.io'}
```
*/
declare function getUrls(text: string, options?: getUrls.Options): Set<string>;

export = getUrls;