# hast-util-find-and-replace

> hast utility to find and replace text in a tree

Latest version **5.0.3** (published 2026-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install hast-util-find-and-replace
pnpm add hast-util-find-and-replace
yarn add hast-util-find-and-replace
bun add hast-util-find-and-replace
```

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

Negative: declining downloads.

## Facts

| | |
|---|---|
| Version | 5.0.3 |
| Published | 2026-10-24 |
| First published | 2016-12-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 4 |
| Unpacked size | 24.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Titus Wormer |
| Maintainers | wooorm, kmck |
| Keywords | find, hast-util, hast, html, replace, utility, util, unist |

## Links

- npm: https://www.npmjs.com/package/hast-util-find-and-replace
- Repository: https://github.com/syntax-tree/hast-util-find-and-replace
- Homepage: https://github.com/syntax-tree/hast-util-find-and-replace#readme
- Issues: https://github.com/syntax-tree/hast-util-find-and-replace/issues
- Funding: https://opencollective.com/unified
- npm.io page: https://npm.io/package/hast-util-find-and-replace

## Dependencies (4)

- [@types/hast](https://npm.io/package/@types/hast.md) ^3.0.0
- [escape-string-regexp](https://npm.io/package/escape-string-regexp.md) ^5.0.0
- [hast-util-is-element](https://npm.io/package/hast-util-is-element.md) ^3.0.0
- [unist-util-visit-parents](https://npm.io/package/unist-util-visit-parents.md) ^6.1.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 5.0.3 (latest) — 2026-10-24
- 5.0.2 — 2026-10-04
- 5.0.1 — 2023-09-21
- 5.0.0 — 2023-08-04
- 4.1.3 — 2023-01-09
- 4.1.2 — 2022-07-13
- 4.1.1 — 2022-05-18
- 4.1.0 — 2022-04-21
- 4.0.0 — 2021-05-10
- 3.2.1 — 2021-02-09
- 3.2.0 — 2020-11-03
- 3.1.0 — 2020-08-21
- 3.0.0 — 2020-02-27
- 2.0.0 — 2019-05-25
- 1.0.4 — 2018-11-07
- … 4 more at https://npm.io/package/hast-util-find-and-replace/versions

## README

# hast-util-find-and-replace

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

[hast][] utility to find and replace things.

## Contents

* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
  * [`defaultIgnore`](#defaultignore)
  * [`findAndReplace(tree, list[, options])`](#findandreplacetree-list-options)
  * [`Find`](#find)
  * [`FindAndReplaceList`](#findandreplacelist)
  * [`FindAndReplaceTuple`](#findandreplacetuple)
  * [`Options`](#options)
  * [`RegExpMatchObject`](#regexpmatchobject)
  * [`Replace`](#replace)
  * [`ReplaceFunction`](#replacefunction)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)

## What is this?

This package is a utility that lets you find patterns (`string`, `RegExp`) in
text and replace them with nodes (such as elements).
It’s aware of HTML (such as ignoring `<style>` and `<script>` by default).

## When should I use this?

This utility is typically useful when you have regexes and want to modify hast.
One example is when you have some form of “mentions” (such as
`/@([a-z][_a-z0-9])\b/gi`) and want to create links to persons from them.

## Install

This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:

```sh
npm install hast-util-find-and-replace
```

In Deno with [`esm.sh`][esmsh]:

```js
import {findAndReplace} from 'https://esm.sh/hast-util-find-and-replace@5'
```

In browsers with [`esm.sh`][esmsh]:

```html
<script type="module">
  import {findAndReplace} from 'https://esm.sh/hast-util-find-and-replace@5?bundle'
</script>
```

## Use

```js
import {h} from 'hastscript'
import {findAndReplace} from 'hast-util-find-and-replace'
import {inspect} from 'unist-util-inspect'

const tree = h('p', [
  'Some ',
  h('em', 'emphasis'),
  ', ',
  h('strong', 'importance'),
  ', and ',
  h('code', 'code'),
  '.'
])

findAndReplace(tree, [
  [/and/gi, 'or'],
  [/emphasis/gi, 'em'],
  [/importance/gi, 'strong'],
  [
    /code/gi,
    function ($0) {
      return h('a', {href: '//example.com#' + $0}, $0)
    }
  ]
])

console.log(inspect(tree))
```

Yields:

```text
element<p>[7]
│ properties: {}
├─0 text "Some "
├─1 element<em>[1]
│   │ properties: {}
│   └─0 text "em"
├─2 text ", "
├─3 element<strong>[1]
│   │ properties: {}
│   └─0 text "strong"
├─4 text ", or "
├─5 element<code>[1]
│   │ properties: {}
│   └─0 element<a>[1]
│       │ properties: {"href":"//example.com#code"}
│       └─0 text "code"
└─6 text "."
```

## API

This package exports the identifiers [`defaultIgnore`][api-default-ignore] and
[`findAndReplace`][api-find-and-replace].
There is no default export.

### `defaultIgnore`

Default tag names to ignore (`Array<string>`).

The defaults are `math`, `script`, `style`, `svg`, and `title`.

### `findAndReplace(tree, list[, options])`

Find patterns in a tree and replace them.

The algorithm searches the tree in *[preorder][]* for complete values in
[`Text`][text] nodes.
Partial matches are not supported.

###### Parameters

* `tree` ([`Node`][node])
  — tree to change
* `list` ([`FindAndReplaceList`][api-find-and-replace-list] or
  [`FindAndReplaceTuple`][api-find-and-replace-tuple])
  — one or more find-and-replace pairs
* `options` ([`Options`][api-options])
  — configuration

###### Returns

Nothing (`undefined`).

### `Find`

Pattern to find (TypeScript type).

Strings are escaped and then turned into global expressions.

###### Type

```ts
type Find = RegExp | string
```

### `FindAndReplaceList`

Several find and replaces, in array form (TypeScript type).

###### Type

```ts
type FindAndReplaceList = Array<FindAndReplaceTuple>
```

See [`FindAndReplaceTuple`][api-find-and-replace-tuple].

### `FindAndReplaceTuple`

Find and replace in tuple form (TypeScript type).

###### Type

```ts
type FindAndReplaceTuple = [Find, Replace?]
```

See [`Find`][api-find] and [`Replace`][api-replace].

### `Options`

Configuration (TypeScript type).

###### Fields

* `ignore` ([`Test`][test], optional)
  — test for which elements to ignore

### `RegExpMatchObject`

Info on the match (TypeScript type).

###### Fields

* `index` (`number`)
  — the index of the search at which the result was found
* `input` (`string`)
  — a copy of the search string in the text node
* `stack` ([`Array<Node>`][node])
  — all ancestors of the text node, where the last node is the text itself

### `Replace`

Thing to replace with (TypeScript type).

###### Type

```ts
type Replace = ReplaceFunction | string | null | undefined
```

See [`ReplaceFunction`][api-replace-function].

### `ReplaceFunction`

Callback called when a search matches (TypeScript type).

###### Parameters

The parameters are the result of corresponding search expression:

* `value` (`string`)
  — whole match
* `...capture` (`Array<string>`)
  — matches from regex capture groups
* `match` ([`RegExpMatchObject`][api-regexp-match-object])
  — info on the match

###### Returns

Thing to replace with:

* when `null`, `undefined`, `''`, remove the match
* …or when `false`, do not replace at all
* …or when `string`, replace with a text node of that value
* …or when `Array<Node>` or `Node`, replace with those nodes

## Types

This package is fully typed with [TypeScript][].
It exports the additional types [`Find`][api-find],
[`FindAndReplaceList`][api-find-and-replace-list],
[`FindAndReplaceTuple`][api-find-and-replace-tuple],
[`Options`][api-options],
[`RegExpMatchObject`][api-regexp-match-object],
[`Replace`][api-replace], and
[`ReplaceFunction`][api-replace-function].

## Compatibility

Projects maintained by the unified collective are compatible with maintained
versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
`hast-util-find-and-replace@^5`, compatible with Node.js 16.

## Security

Use of `hast-util-find-and-replace` can open you up to a
[cross-site scripting (XSS)][xss] attack if a value used to `replace` is unsafe.
Use [`hast-util-santize`][hast-util-sanitize] to make the hast tree safe.

The following example shows how a script is injected that runs when loaded in a
browser.

```js
const tree = h('p', 'This and that.')

findAndReplace(tree, 'and', function () {
  return h('script', 'alert(1)')
})
```

Yields:

```html
<p>This <script>alert(1)</script> that.</p>
```

## Related

* [`hast-util-select`](https://github.com/syntax-tree/hast-util-select)
  — `querySelector`, `querySelectorAll`, and `matches`
* [`mdast-util-find-and-replace`](https://github.com/syntax-tree/mdast-util-find-and-replace)
  — find and replace in mdast
* [`unist-util-select`](https://github.com/syntax-tree/unist-util-select)
  — select unist nodes with CSS-like selectors

## Contribute

See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for
ways to get started.
See [`support.md`][support] for ways to get help.

This project has a [code of conduct][coc].
By interacting with this repository, organisation, or community you agree to
abide by its terms.

## License

[MIT][license] © [Titus Wormer][author]

<!-- Definition -->

[api-default-ignore]: #defaultignore

[api-find]: #find

[api-find-and-replace]: #findandreplacetree-list-options

[api-find-and-replace-list]: #findandreplacelist

[api-find-and-replace-tuple]: #findandreplacetuple

[api-options]: #options

[api-regexp-match-object]: #regexpmatchobject

[api-replace]: #replace

[api-replace-function]: #replacefunction

[author]: https://wooorm.com

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[build]: https://github.com/syntax-tree/hast-util-find-and-replace/actions

[build-badge]: https://github.com/syntax-tree/hast-util-find-and-replace/workflows/main/badge.svg

[chat]: https://github.com/syntax-tree/unist/discussions

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md

[collective]: https://opencollective.com/unified

[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md

[coverage]: https://codecov.io/github/syntax-tree/hast-util-find-and-replace

[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-find-and-replace.svg

[downloads]: https://www.npmjs.com/package/hast-util-find-and-replace

[downloads-badge]: https://img.shields.io/npm/dm/hast-util-find-and-replace.svg

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[hast]: https://github.com/syntax-tree/hast

[hast-util-sanitize]: https://github.com/syntax-tree/hast-util-sanitize

[health]: https://github.com/syntax-tree/.github

[license]: license

[node]: https://github.com/syntax-tree/hast#ndoes

[npm]: https://docs.npmjs.com/cli/install

[preorder]: https://github.com/syntax-tree/unist#preorder

[size]: https://bundlejs.com/?q=hast-util-find-and-replace

[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-find-and-replace

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[support]: https://github.com/syntax-tree/.github/blob/main/support.md

[test]: https://github.com/syntax-tree/hast-util-is-element#test

[text]: https://github.com/syntax-tree/hast#text

[typescript]: https://www.typescriptlang.org

[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting

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