GoScrobble/web/node_modules/astral-regex/readme.md

839 B

astral-regex Build Status

Regular expression for matching astral symbols

Install

$ npm install astral-regex

Usage

const astralRegex = require('astral-regex');

astralRegex({exact: true}).test('🦄');
//=> true

'foo 🦄 💩 bar'.match(astralRegex());
//=> ['🦄', '💩']

API

astralRegex([options])

Returns a RegExp for matching astral symbols.

options

Type: Object

exact

Type: boolean
Default: false (Matches any astral symbols in a string)

Only match an exact string. Useful with RegExp#test() to check if a string is a astral symbol.

License

MIT © Kevin Mårtensson