Escapes input characters to be used in regular expressions.
Last updated 3 years ago by ionicabizau .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install regex-escape 
SYNC missed versions from official npm registry.


Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

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");

// => \{#\/\}

:question: Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

  2. For bug reports and feature requests, open issues. :bug:

  3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation


Escapes a string for using it in a regular expression.


  • String input: The string that must be escaped.


  • String The escaped string.


Adds the RegexEscape function to RegExp class.


  • 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:

  • Buy me a book—I love books! I will remember you after years if you buy me one. :grin: :book:

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. :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! :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:

  • barbe—Like mustache, but simple, tiny and fast.
  • bloggify-router (by Bloggify)—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 poll
  • emoji.css—Your website. Emojified. Like FontAwesome for emojis.
  • engine-flow-types (by jillix)—Low level library providing Engine flow types.
  • gatsby-plugin-compile-es6-packages (by Rob Walker)—Easily add support for compiling ES6 packages into Gasby projects
  • 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
  • items-service—Les services commun de gestion d'items dans blueforest
  • kresus—Kresus' Personal Finance Manager
  • luhnify (by Samm Cooper)—Generate random Luhn sequences, such as credit card numbers.
  • parse-it—Configurable string templating, without separators.
  • slugly—A minimal and yet powerful slug library.
  • taskcluster-lib-references (by Dustin J. Mitchell)—Taskcluster-lib-references is responsible for handling the API reference data, including manifests, API references, exchange references, and JSON schemas.

:scroll: License

MIT © Ionică Bizău

Current Tags

  • 3.4.9                                ...           latest (2 years ago)

16 Versions

  • 3.4.9                                ...           2 years ago
  • 3.4.8                                ...           3 years ago
  • 3.4.7                                ...           3 years ago
  • 3.4.6                                ...           3 years ago
  • 3.4.5                                ...           3 years ago
  • 3.4.4                                ...           4 years ago
  • 3.4.3                                ...           4 years ago
  • 3.4.2                                ...           4 years ago
  • 3.4.1                                ...           5 years ago
  • 3.4.0                                ...           5 years ago
  • 3.3.0                                ...           5 years ago
  • 3.2.0                                ...           5 years ago
  • 3.1.0                                ...           5 years ago
  • 3.0.0                                ...           5 years ago
  • 2.0.0                                ...           5 years ago
  • 1.0.0                                ...           5 years ago

Copyright 2014 - 2017 © |