summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/astral-regex/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/node_modules/eslint/node_modules/astral-regex/readme.md')
-rw-r--r--tools/node_modules/eslint/node_modules/astral-regex/readme.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/tools/node_modules/eslint/node_modules/astral-regex/readme.md b/tools/node_modules/eslint/node_modules/astral-regex/readme.md
index cde44f7bc0..89d6659a41 100644
--- a/tools/node_modules/eslint/node_modules/astral-regex/readme.md
+++ b/tools/node_modules/eslint/node_modules/astral-regex/readme.md
@@ -1,6 +1,6 @@
# astral-regex [![Build Status](https://travis-ci.org/kevva/astral-regex.svg?branch=master)](https://travis-ci.org/kevva/astral-regex)
-> Regular expression for matching astral symbols
+> Regular expression for matching [astral symbols](https://everything2.com/title/astral+plane)
## Install
@@ -15,8 +15,11 @@ $ npm install astral-regex
```js
const astralRegex = require('astral-regex');
-astralRegex({exact: true}).test('');
+astralRegex({exact: true}).test('🦄');
//=> true
+
+'foo 🦄 💩 bar'.match(astralRegex());
+//=> ['🦄', '💩']
```