.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / clone-regexp / readme.md
1 # clone-regexp [![Build Status](https://travis-ci.org/sindresorhus/clone-regexp.svg?branch=master)](https://travis-ci.org/sindresorhus/clone-regexp)
2
3 > Clone and modify a [RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) instance
4
5
6 ## Install
7
8 ```sh
9 $ npm install --save clone-regexp
10 ```
11
12
13 ## Usage
14
15 ```js
16 var cloneRegexp = require('clone-regexp');
17 var re = /[a-z]/gi;
18
19 cloneRegexp(re);
20 //=> /[a-z]/gi
21
22 cloneRegexp(re) === re;
23 //=> false
24
25 cloneRegexp(re, {global: false});
26 //=> /[a-z]/i
27
28 cloneRegexp(re, {multiline: true});
29 //=> /[a-z]/gim
30
31 cloneRegexp(re, {source: 'unicorn'});
32 //=> /unicorn/gi
33 ```
34
35
36 ## API
37
38 ### cloneRegexp(regexp, [options])
39
40 #### regex
41
42 Type: `regexp`
43
44 RegExp instance to clone.
45
46
47 #### options
48
49 Type: `object`  
50 Properties: [`source`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/source) [`global`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/global) [`ignoreCase`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/ignoreCase) [`multiline`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/multiline) [`sticky`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/sticky) [`unicode`](http://norbertlindenberg.com/2012/05/ecmascript-supplementary-characters/#RegExp)
51
52 Optionally modify the cloned RegExp instance.
53
54
55 ## License
56
57 MIT © [Sindre Sorhus](http://sindresorhus.com)