Require Node.js 8

Author: sindresorhus

.travis.yml

@@ -1,5 +1,5 @@
 language: node_js
 node_js:
+  - '12'
   - '10'
   - '8'
-  - '6'

index.d.ts

@@ -1,16 +1,37 @@
-export interface Options {
-	/**
-	 * Only match an exact string.
-	 *
-	 * @default false
-	 */
-	exact?: boolean
+declare namespace emailRegex {
+	export interface Options {
+		/**
+		Only match an exact string.
+
+		Useful with `RegExp#test` to check if a string is an email address.
+
+		@default false
+		*/
+		exact?: boolean
+	}
 }
 
 /**
- * Returns a regex for matching email addresses.
- *
- * @param options - Configure the generated regular expression
- * @returns Regex for matching email addresses.
- */
-export default function emailRegex(options?: Options): RegExp;
+Regular expression for matching email addresses.
+
+Use it for finding email addresses or checking if something is email like. [You shouldn't use this for validating emails.](http://davidcel.is/blog/2012/09/06/stop-validating-email-addresses-with-regex/) Only for hinting to the user.
+
+@example
+```
+import emailRegex = require('email-regex');
+
+// Contains an email address
+emailRegex().test('unicorn [email protected]');
+//=> true
+
+// Is an email address
+emailRegex({exact: true}).test('[email protected]');
+//=> true
+
+'unicorn [email protected] cake [email protected] rainbow'.match(emailRegex());
+//=> ['[email protected]', '[email protected]']
+```
+*/
+declare function emailRegex(options?: emailRegex.Options): RegExp;
+
+export = emailRegex

index.js

@@ -1,5 +1,5 @@
 'use strict';
 
-const re = '[^\\.\\s@:](?:[^\\s@:]*[^\\s@:\\.])?@[^\\.\\s@]+(?:\\.[^\\.\\s@]+)*';
+const regex = '[^\\.\\s@:](?:[^\\s@:]*[^\\s@:\\.])?@[^\\.\\s@]+(?:\\.[^\\.\\s@]+)*';
 
-module.exports = (options = {}) => options.exact ? new RegExp(`^${re}$`) : new RegExp(re, 'g');
+module.exports = ({exact} = {}) => exact ? new RegExp(`^${regex}$`) : new RegExp(regex, 'g');

index.test-d.ts

@@ -1,8 +1,6 @@
-import {expectType} from 'tsd-check';
-import emailRegex from '.';
+import {expectType} from 'tsd';
+import emailRegex = require('.');
 
-(async () => {
-	expectType<RegExp>(emailRegex());
-	expectType<RegExp>(emailRegex({}));
-	expectType<RegExp>(emailRegex({ exact: true }));
-})();
+expectType<RegExp>(emailRegex());
+expectType<RegExp>(emailRegex({}));
+expectType<RegExp>(emailRegex({exact: true}));

package.json

@@ -10,37 +10,31 @@
 		"url": "sindresorhus.com"
 	},
 	"engines": {
-		"node": ">=6"
+		"node": ">=8"
 	},
 	"scripts": {
-		"test": "xo && ava && tsd-check"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
 		"index.js",
 		"index.d.ts"
 	],
 	"keywords": [
-		"text",
-		"string",
+		"email",
+		"address",
 		"regex",
 		"regexp",
-		"re",
+		"string",
 		"match",
+		"text",
 		"test",
 		"find",
 		"pattern",
-		"validate",
-		"email",
-		"address"
+		"validate"
 	],
 	"devDependencies": {
-		"ava": "*",
-		"tsd-check": "^0.3.0",
-		"xo": "*"
-	},
-	"xo": {
-		"ignores": [
-			"*.ts"
-		]
+		"ava": "^2.1.0",
+		"tsd": "^0.7.3",
+		"xo": "^0.24.0"
 	}
 }

readme.md

@@ -34,21 +34,18 @@ emailRegex({exact: true}).test('[email protected]');
 
 ## API
 
-### emailRegex([options])
+### emailRegex(options?)
 
 Returns a regex for matching email addresses.
 
 #### options
 
+Type: `object`
+
 ##### exact
 
 Type: `boolean`<br>
 Default: `false` *(Matches any email address in a string)*
 
 Only match an exact string.<br>
 Useful with `RegExp#test` to check if a string is an email address.
-
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)

test.js

@@ -1,7 +1,7 @@
 import test from 'ava';
-import m from '.';
+import emailRegex from '.';
 
-const fixture = [
+const fixtures = [
 	'[email protected]',
 	'foo@bar',
 	'[email protected]',
@@ -28,7 +28,7 @@ const fixture = [
 	'foo@[IPv6:2001:db8::2]'
 ];
 
-const fixtureNot = [
+const fixturesNot = [
 	'@',
 	'@io',
 	'@sindresorhus.com',
@@ -43,21 +43,21 @@ const fixtureNot = [
 ];
 
 test('extract', t => {
-	for (const x of fixture) {
-		t.is((m().exec(`foo ${x} bar`) || [])[0], x);
+	for (const fixture of fixtures) {
+		t.is((emailRegex().exec(`foo ${fixture} bar`) || [])[0], fixture);
 	}
 
-	t.is(m().exec('mailto:[email protected]')[0], '[email protected]');
+	t.is(emailRegex().exec('mailto:[email protected]')[0], '[email protected]');
 });
 
 test('exact', t => {
-	for (const x of fixture) {
-		t.true(m({exact: true}).test(x));
+	for (const fixture of fixtures) {
+		t.true(emailRegex({exact: true}).test(fixture));
 	}
 });
 
 test('failures', t => {
-	for (const x of fixtureNot) {
-		t.false(m({exact: true}).test(x));
+	for (const fixture of fixturesNot) {
+		t.false(emailRegex({exact: true}).test(fixture));
 	}
 });