.config/coc/extensions/node_modules/coc-prettier/node_modules/astral-regex/readme.md

   1 # astral-regex [![Build Status](https://travis-ci.org/kevva/astral-regex.svg?branch=master)](https://travis-ci.org/kevva/astral-regex)
   2
   3 > Regular expression for matching astral symbols
   4
   5
   6 ## Install
   7
   8 ```
   9 $ npm install astral-regex
  10 ```
  11
  12
  13 ## Usage
  14
  15 ```js
  16 const astralRegex = require('astral-regex');
  17
  18 astralRegex({exact: true}).test('');
  19 //=> true
  20 ```
  21
  22
  23 ## API
  24
  25 ### astralRegex([options])
  26
  27 Returns a `RegExp` for matching astral symbols.
  28
  29 #### options
  30
  31 Type: `Object`
  32
  33 ##### exact
  34
  35 Type: `boolean`<br>
  36 Default: `false` *(Matches any astral symbols in a string)*
  37
  38 Only match an exact string. Useful with `RegExp#test()` to check if a string is a astral symbol.
  39
  40
  41 ## License
  42
  43 MIT © [Kevin Mårtensson](https://github.com/kevva)