issue-regex
Version:
Regular expression for matching issue references
18 lines (13 loc) • 570 B
TypeScript
/**
Regular expression for matching issue references.
@param options.prefix - Additional prefix for references like `GH-123`. Adding a prefix will still match the #-based references. `prefix` is added unescaped to the regex, keep it simple.
@example
```
import issueRegex from 'issue-regex';
'Fixes #143 and avajs/ava#1023'.match(issueRegex());
//=> ['#143', 'avajs/ava#1023']
'GH-143 is the same as #143'.match(issueRegex({additionalPrefix: 'GH-'}));
//=> ['GH-143', '#143']
```
*/
export default function issueRegex(options?: {additionalPrefix?: string}): RegExp;