regex-escape

Escapes input characters to be used in regular expressions.

:cloud: Installation

# Using npm
npm install --save regex-escape

# Using yarn
yarn add regex-escape

:clipboard: Example

// Dependencies
var RegexEscape = require("regex-escape");

console.log(RegexEscape("{#/}"));
// => \{#\/\}

:question: Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. :bug:
For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

`RegexEscape(input)`

Escapes a string for using it in a regular expression.

Params

String input: The string that must be escaped.

Return

String The escaped string.

`proto()`

Adds the RegexEscape function to RegExp class.

Return

Function The RegexEscape function.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! :heart:

:cake: Thanks

Big thanks to CoolAj86 for posting this answer. This library uses the black magic regex from that answer. :sparkles:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

gatsby-plugin-compile-es6-packages
html-encoder-decoder
camelo
barbe
slugly
bloggify-router
engine-flow-types
hubot-lgtm
nexl-engine
css-assets
doodle-data
chance-token-replacer
@crstn/redirect
items-service
@georgenorris/currency-symbol-to-code
taskcluster-lib-references
context-url-extractor
luhnify
custom-tpl
parcel-plugin-custom-dist-structure
kresus
emoji.css
parse-it

:scroll: License

Current Tags

3.4.9 ... latest (7 years ago)

2 Versions

3.4.10 ... 5 years ago
3.4.9 ... 7 years ago