3
0
Fork 0
mirror of https://gitea.com/actions/setup-python.git synced 2024-11-22 18:19:35 +01:00
setup-python/node_modules/astral-regex/readme.md
Danny McCormick 39c08a0eaa Initial pass
2019-06-26 21:12:00 -04:00

43 lines
724 B
Markdown

# 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
## Install
```
$ npm install astral-regex
```
## Usage
```js
const astralRegex = require('astral-regex');
astralRegex({exact: true}).test('');
//=> true
```
## API
### astralRegex([options])
Returns a `RegExp` for matching astral symbols.
#### options
Type: `Object`
##### exact
Type: `boolean`<br>
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](https://github.com/kevva)