Miss any of our Open RFC calls?Watch the recordings here! »

regex-escape

3.4.5 • Public • Published

regex-escape

Support me on Patreon Buy me a book PayPal Version Downloads

Escapes input characters to be used in regular expressions.

☁️ Installation

$ npm i --save regex-escape

📋 Example

// Dependencies
var RegexEscape = require("regex-escape");
 
console.log(RegexEscape("{#/}"));
// => \{#\/\}

📝 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.

😋 How to contribute

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

💖 Support my projects

I open-source almost everything I can, and I try to reply 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 🚀

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—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! ❤️

🍰 Thanks

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

💫 Where is this library used?

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

  • barbe—Like mustache, but simple, tiny and fast.
  • bloggify-router—The default Bloggify router.
  • camelo—Convert a string into camel case style by providing the separators.
  • chance-token-replacer (by Drew Brokke)—A simple utility to replace tokens in a string with generations from the chance random generator helper
  • css-assets (by Manoj Chandrashekar)—Helps build CSS files and referenced assets.
  • doodle-data (by Jan Bölsche)—get the data of a doodle.com poll
  • engine-flow-types (by jillix)—Low level library providing Engine flow types.
  • html-encoder-decoder—HTML Encoder / Decoder - Converts characters to their corresponding HTML Entities
  • hubot-lgtm (by Chris Contolini)—Automatically merge pull requests after contributors have given the thumbs up
  • luhnify (by Samm Cooper)—Generate random Luhn sequences, such as credit card numbers.
  • parse-it—Configurable string templating, without separators.

📜 License

MIT © Ionică Bizău

Keywords

Install

npm i [email protected]

Version

3.4.5

License

MIT

Last publish

Collaborators

  • avatar