You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

123 lines
5.7 KiB

4 years ago
  1. <!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
  2. # regex-parser
  3. [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/regex-parser.svg)](https://www.npmjs.com/package/regex-parser) [![Downloads](https://img.shields.io/npm/dt/regex-parser.svg)](https://www.npmjs.com/package/regex-parser) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
  4. <a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
  5. > A module that parses a string as regular expression and returns the parsed value.
  6. ## :cloud: Installation
  7. ```sh
  8. # Using npm
  9. npm install --save regex-parser
  10. # Using yarn
  11. yarn add regex-parser
  12. ```
  13. ## :clipboard: Example
  14. ```js
  15. // Dependencies
  16. var RegexParser = require("regex-parser");
  17. console.log(RegexParser("/^hi$/g"));
  18. // => /^hi$/g
  19. ```
  20. ## :question: Get Help
  21. There are few ways to get help:
  22. 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
  23. 2. For bug reports and feature requests, open issues. :bug:
  24. 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
  25. ## :memo: Documentation
  26. ### `RegexParser(input)`
  27. Parses a string input.
  28. #### Params
  29. - **String** `input`: The string input that should be parsed as regular expression.
  30. #### Return
  31. - **RegExp** The parsed regular expression.
  32. ## :yum: How to contribute
  33. Have an idea? Found a bug? See [how to contribute][contributing].
  34. ## :sparkling_heart: Support my projects
  35. I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
  36. 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).
  37. 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:
  38. - Starring and sharing the projects you like :rocket:
  39. - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
  40. - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
  41. - [![Support me on Patreon][badge_patreon]][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).
  42. - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
  43. ![](https://i.imgur.com/z6OQI95.png)
  44. Thanks! :heart:
  45. ## :dizzy: Where is this library used?
  46. If you are using this library in one of your projects, add it in this list. :sparkles:
  47. - [`adjust-sourcemap-loader`](https://github.com/bholloway/adjust-sourcemap-loader) (by bholloway)—Webpack loader that adjusts source maps
  48. - [`bible`](https://github.com/BibleJS/BibleApp)—Read the Holy Bible via the command line.
  49. - [`bible.js`](https://github.com/BibleJS/bible.js)—The Bible as a NPM module.
  50. - [`draper`](https://github.com/gajus/surgeon#readme) (by Gajus Kuizinas)—DOM extraction expression evaluator.
  51. - [`gene-js`](https://github.com/nicosommi/gene-js) (by nicosommi)—an add utility
  52. - [`leadconduit-custom`](https://github.com/activeprospect/leadconduit-integration-custom#readme) (by Alex Wolfe)—LeadConduit custom integration
  53. - [`palantir`](https://github.com/gajus/palantir#readme) (by Gajus Kuizinas)—Active monitoring and alerting system using user-defined Node.js scripts.
  54. - [`panko`](https://npmjs.com/package/panko)—A collection of functions that make panko work. This package is for plugin creators, not users.
  55. - [`panko-cli`](https://npmjs.com/package/panko-cli)—A CLI-based project manager that reads from a list of separate profiles and allows various tasks to be completed.
  56. - [`rendition`](https://github.com/resin-io-modules/rendition#readme)—React components library
  57. - [`starts-with-emoji`](https://github.com/IonicaBizau/starts-with-emoji#readme)—Check if a string starts with an emoji.
  58. - [`statique`](https://github.com/IonicaBizau/statique)—A Node.JS static server module with built-in cache options and route features.
  59. - [`surgeon`](https://github.com/gajus/surgeon#readme) (by Gajus Kuizinas)—Declarative DOM extraction expression evaluator.
  60. - [`twing`](https://github.com/ericmorand/twing) (by Eric MORAND)—First-class Twig engine for Node.js
  61. ## :scroll: License
  62. [MIT][license] © [Ionică Bizău][website]
  63. [badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
  64. [badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
  65. [badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
  66. [badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
  67. [patreon]: https://www.patreon.com/ionicabizau
  68. [amazon]: http://amzn.eu/hRo9sIZ
  69. [paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
  70. [license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2014#license-mit
  71. [website]: https://ionicabizau.net
  72. [contributing]: /CONTRIBUTING.md
  73. [docs]: /DOCUMENTATION.md