Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1.26 KB

README.md

File metadata and controls

43 lines (29 loc) · 1.26 KB

regex-format Build Status Dependency Status DevDependency Status

npm

Format regex with string substitutions.

Example

regexFormat(/^Author:\s+{#name} <{#email}>$/, {
  name: 'someone',
  email: 'someone@example.com'
})
//=> /^Author:\s+someone <someone@example\.com>$/

regexFormat(/^{}$/, 'foo$1')
//=> /^foo\$1$/

API

regexFormat(spec, [values]...)

spec is a RegExp, otherwise it is converted to RegExp. Flags are preserved.

The syntax for substitutions is the same as accepted by string-format, except that non-empty groups are prepended with a hash sign: {#0}, {#foo.bar}, etc (empty groups are still {}).

Install

npm install regex-format

License

MIT