Skip to content

Commit b3640f4

Browse files
author
Charlike Mike Reagent
committed
reorder readme
1 parent c220ca2 commit b3640f4

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

readme.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,19 @@ $ npm test
1111
```
1212

1313

14+
## [.metntionsRegex](index.js#L16)
15+
> Default regex is `\s+@(\w{1,30}|[A-Za-z0-9_.]{1,30})\s+`
16+
17+
* `[options]` **{Object}**
18+
- `startSpace` **{Boolean}** if `false`, will remove starting `\s+` from regex
19+
- `endSpace` **{Boolean}** if `false`, will remove ending `\s+` from regex
20+
- `length` **{Number}** maximum length of mention, default `30`
21+
- `match` **{String}** what to match, default is `\w{1,30}`
22+
- `flags` **{String}** every valid RegExp flag, default `undefined`
23+
- `dot` **{Boolean}** replace options.match which is `\w` with `[A-Za-z0-9_.]`
24+
* `return` **{RegExp}**
25+
26+
1427
## Usage
1528
> For more use-cases see [tests](./test.js)
1629
@@ -60,19 +73,6 @@ str.match(mentionsRegex({flags: 'g', dot: true, startSpace: false, endSpace: fal
6073
```
6174

6275

63-
## [.metntionsRegex](index.js#L16)
64-
> Default regex is `\s+@(\w{1,30}|[A-Za-z0-9_.]{1,30})\s+`
65-
66-
* `[options]` **{Object}**
67-
- `startSpace` **{Boolean}** if `false`, will remove starting `\s+` from regex
68-
- `endSpace` **{Boolean}** if `false`, will remove ending `\s+` from regex
69-
- `length` **{Number}** maximum length of mention, default `30`
70-
- `match` **{String}** what to match, default is `\w{1,30}`
71-
- `flags` **{String}** every valid RegExp flag, default `undefined`
72-
- `dot` **{Boolean}** replace options.match which is `\w` with `[A-Za-z0-9_.]`
73-
* `return` **{RegExp}**
74-
75-
7676
## Authors & Contributors
7777
**Charlike Mike Reagent** [![author tips][author-gittip-img]][author-gittip]
7878
+ [gittip/tunnckoCore][author-gittip]

0 commit comments

Comments
 (0)