Skip to content

Repository files navigation

replace-case NPM versionNPM monthly downloadsNPM total downloadsTests

Like String.prototype.replace() but attempts to match the casing of the substring being replaced.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save replace-case

Usage

constreplace=require('replace-case');constinput='foo Foo FOO foo';// Uses "gi" RegExp flags by defaultconsole.log(replace(input,'foo','bar'));//=> bar Bar BAR barconsole.log(replace(input,'[fF]oo','bar','g'));//=> bar Bar FOO barconsole.log(replace(input,'foo','bar','i'));//=> bar Foo FOO fooconsole.log(replace(input,'foo','bar',''));//=> bar Foo FOO foo

Signature

replace(input,substring,replacement[,flags]);

Params

  • input (String) The string to modify
  • substring (String) The "old" string to replace
  • replacement (String) The "new" string to use as a replacement.
  • flags (String) Optional RegExp flags to use. By default, gi is used.

Usage Examples

constinput=` .alphaconfig.json AlphaWord Alpha ALPHA_FOO_BAR`;// Replace all occurrences of "alpha" with "beta"console.log(replace(input,'alpha','beta'));// Replace only the first occurrence of "alpha" with "beta"console.log(replace(input,'alpha','beta','i'));// Replace only when surrounded by word boundaries (capture group is unecessary and is only for clarity)console.log(replace(input,'\\b(?:alpha)\\b','beta'));// Replace all occurrences of "alpha" (optionally followed by "config") with "beta"console.log(replace(input,'alpha(config)*','beta'));// Replace all occurrences of "alpha" (optionally followed by zero or more characters that are// not a space, underscore, or dot)console.log(replace(input,'alpha([^\\s_.]*)','beta'));

Results in the following:

 .betaconfig.json
BetaWord
Beta
BETA_FOO_BAR
.betaconfig.json
AlphaWord
Alpha
ALPHA_FOO_BAR
.alphaconfig.json
AlphaWord
Beta
ALPHA_FOO_BAR
.beta.json
BetaWord
Beta
BETA_FOO_BAR
.beta.json
beta
Beta
BETA_FOO_BAR

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Author

Jon Schlinkert

License

Copyright © 2023, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.8.0, on November 03, 2023.

About

Like String.prototype.replace() but attempts to match the casing of the substring being replaced. Useful when renaming mixed-case variables, refactoring code or moving hard-coded values into variables.

Topics

Resources

Contributing

Stars

10 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages