regs
Linux & OSX | Windows |
---|---|
Useful regular expressions for JavaScript
Install
npm install --save regs
Usage
Node
const regs = ; regs;//=> true regs1//=> 'var1'
Web
Supported regexp types
- yeoman (
regs.yeoman()
) - trim (
regs.trim()
) - email (
regs.email()
) - githubIssue (
regs.githubIssue()
) - markdownHeader (
regs.markdownHeader()
)
API
-
Each function call returns a
RegExp object
which can then operate on/with. -
Each function call supports (optionally) the official RegExp flags which alter behavior of the search. (ex: 'g' for global or 'i' to ignore case)
regs.yeoman([RegExpFlags])
Capture text between <% %>
or <%= %>
.
1
capture group - the value between delimeters.
Example:
regs1;//=> 'capture this'
regs.trim([RegExpFlags])
Capture text without surrounding spaces.
1
capture group - the value between starting and ending spaces.
Example:
regs1;//=> 'var1'
regs.email([RegExpFlags])
Capture all three parts of an email address. Example:
3
capture groups -
- Name (before
@
) - Domain body (between
@
and.
) - Domain suffix (
com
,io
, etc.)
Example:
// Simple validationregs;//=> true // Capture all partsregs;//=> [ 'hi@me.io', 'hi', 'me', 'io', index: 0, input: 'hi@me.io' ]
regs.githubIssue([RegExpFlags])
Capture number following a pound (GitHub issue reference)
1
capture group - The numeric value of the issue
Example:
regs1;//=> '98'
regs.markdownHeader(headerNumber [, RegExpFlags])
Capture text following a markdown header pound (#
)
1
capture group - Text following the header
headerNumber
examples:
- An
h1
in markdown is# <text>
, and theheaderNumber
should be set to 1 - An
h3
in markdown is### <text>
, and theheaderNumber
should be set to 3
Example:
regs1;//=> 'my header 1' regs1;//=> 'my header 4'
Similar
License
MIT © Dawson Botsford