JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 179085
  • Score
    100M100P100Q162230F
  • License MIT

Replace all substring matches in a string

Package Exports

  • replace-string

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (replace-string) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

replace-string Build Status

Replace all substring matches in a string

Similar to String#replace(), but supports replacing multiple matches. You could achieve something similar by putting the string in a RegExp constructor with the global flag and passing it to String#replace(), but you would then have to first escape the string anyways.

Install

$ npm install replace-string

Usage

const replaceString = require('replace-string');

const string = 'My friend has a 🐑. I want a 🐑 too!';

replaceString(string, '🐑', '🦄');
//=> 'My friend has a 🦄. I want a 🦄 too!'

API

replaceString(string, needle, replacement, options?)

Returns a new string with all needle matches replaced with replacement.

string

Type: string

String to work on.

needle

Type: string

String to match in input.

replacement

Type: string | Function

Replacement for needle matches.

If a function, it receives the matched substring, the match count, the original input, and the index in which the match happened (as measured from the original input):

replaceString('Foo 🐑 Bar', '🐑', (matchedSubstring, matchCount, input, matchIndex) => `${matchedSubstring}❤️`);
//=> 'Foo 🐑❤️ Bar'

options

Type: object

fromIndex

Type: number
Default: 0

Index at which to start replacing.

caseInsensitive

Type: boolean
Default: false

Whether or not substring matching should be case-insensitive.

  • execall - Find multiple RegExp matches in a string