# replace-string

> Replace all substring matches in a string

Latest version **4.0.0** (published 2021-08-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install replace-string
pnpm add replace-string
yarn add replace-string
bun add replace-string
```

## Health

**Score 28/100 (F)** — status: abandoned.

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2021-08-09 |
| First published | 2017-01-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/replace-string) |
| Module format | ESM |
| Node | ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0 |
| Dependencies | 0 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 90 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | replace, string, text, all, many, multiple, global, match, matches, replacement, replacer, modify, substring, sub-string, needle, search, replaceall |

## Links

- npm: https://www.npmjs.com/package/replace-string
- Repository: https://github.com/sindresorhus/replace-string
- Homepage: https://github.com/sindresorhus/replace-string#readme
- Issues: https://github.com/sindresorhus/replace-string/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/replace-string

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 4.0.0 (latest) — 2021-08-09
- 3.1.0 — 2020-05-10
- 3.0.0 — 2019-04-26
- 2.0.0 — 2018-10-16
- 1.1.0 — 2017-01-11
- 1.0.0 — 2017-01-05

## README

# replace-string

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

*With [Node.js 16](https://medium.com/@nodejs/node-js-v15-0-0-is-here-deb00750f278), this package is partly moot as there is now a [`String#replaceAll`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replaceAll) method. However, it does not have a `caseInsensitive` option.*

## Install

```
$ npm install replace-string
```

## Usage

```js
import replaceString from '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`

The string to work on.

#### needle

Type: `string`

The string to match in `input`.

#### replacement

Type: `string | Function`

The 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):

```js
import replaceString from 'replace-string';

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.

## Related

- [execall](https://github.com/sindresorhus/execall) - Find multiple `RegExp` matches in a string

---
_Source: https://npm.io/package/replace-string · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._