# nlcst-search

> nlcst utility to search for patterns in a tree

Latest version **4.0.0** (published 2023-07-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install nlcst-search
pnpm add nlcst-search
yarn add nlcst-search
bun add nlcst-search
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2023-07-17 |
| First published | 2016-01-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 4 |
| Unpacked size | 15.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Titus Wormer |
| Maintainers | wooorm, kmck |
| Keywords | unist, nlcst, nlcst-util, util, utility, pattern, search |

## Links

- npm: https://www.npmjs.com/package/nlcst-search
- Repository: https://github.com/syntax-tree/nlcst-search
- Homepage: https://github.com/syntax-tree/nlcst-search#readme
- Issues: https://github.com/syntax-tree/nlcst-search/issues
- Funding: https://opencollective.com/unified
- npm.io page: https://npm.io/package/nlcst-search

## Dependencies (4)

- [@types/nlcst](https://npm.io/package/@types/nlcst.md) ^2.0.0
- [nlcst-normalize](https://npm.io/package/nlcst-normalize.md) ^4.0.0
- [nlcst-is-literal](https://npm.io/package/nlcst-is-literal.md) ^3.0.0
- [unist-util-visit](https://npm.io/package/unist-util-visit.md) ^5.0.0

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 4.0.0 (latest) — 2023-07-17
- 3.1.1 — 2023-01-19
- 3.1.0 — 2021-08-27
- 3.0.0 — 2021-04-20
- 2.0.0 — 2020-02-18
- 1.5.1 — 2019-05-24
- 1.5.0 — 2018-08-08
- 1.4.3 — 2018-05-02
- 1.4.2 — 2017-07-24
- 1.4.1 — 2017-06-13
- 1.4.0 — 2016-11-19
- 1.3.0 — 2016-05-14
- 1.2.0 — 2016-03-31
- 1.1.1 — 2016-02-04
- 1.1.0 — 2016-01-18
- … 1 more at https://npm.io/package/nlcst-search/versions

## README

# nlcst-search

[![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]

[nlcst][] utility to search for phrases in a tree.

## Contents

*   [What is this?](#what-is-this)
*   [When should I use this?](#when-should-i-use-this)
*   [Install](#install)
*   [Use](#use)
*   [API](#api)
    *   [`search(tree, phrases, handler[, options])`](#searchtree-phrases-handler-options)
    *   [`Handler`](#handler)
    *   [`Options`](#options)
*   [Types](#types)
*   [Compatibility](#compatibility)
*   [Related](#related)
*   [Contribute](#contribute)
*   [License](#license)

## What is this?

This utility can search for phrases (words and phrases) in trees.

## When should I use this?

This package is a tiny utility that helps when you’re searching for words
and phrases.

## Install

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

```sh
npm install nlcst-search
```

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

```js
import {search} from 'https://esm.sh/nlcst-search@4'
```

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

```html
<script type="module">
  import {search} from 'https://esm.sh/nlcst-search@4?bundle'
</script>
```

## Use

```js
import {search} from 'nlcst-search'
import {toString} from 'nlcst-to-string'

const tree = {
  type: 'SentenceNode',
  children: [
    {
      type: 'WordNode',
      children: [
        {type: 'TextNode', value: 'Don'},
        {type: 'PunctuationNode', value: '’'},
        {type: 'TextNode', value: 't'}
      ]
    },
    {type: 'WhiteSpaceNode', value: ' '},
    {
      type: 'WordNode',
      children: [{type: 'TextNode', value: 'do'}]
    },
    {type: 'WhiteSpaceNode', value: ' '},
    {
      type: 'WordNode',
      children: [
        {type: 'TextNode', value: 'Block'},
        {type: 'PunctuationNode', value: '-'},
        {type: 'TextNode', value: 'level'}
      ]
    }
  ]
}

search(tree, ['dont'], function(nodes) {
  console.log(toString(nodes))
})
// `Don’t`

search(tree, ['do blocklevel'], function(nodes) {
  console.log(toString(nodes))
})
// `do Block-level`
```

## API

This package exports the identifier [`search`][api-search].
There is no default export.

### `search(tree, phrases, handler[, options])`

Search for phrases in a tree.

Each phrase is a space-separated list of words, where each word will be
[normalized][nlcst-normalize] to remove casing, apostrophes, and dashes.
Spaces in a pattern mean one or more whitespace nodes in the tree.
Instead of a word with letters, it’s also possible to use a wildcard symbol
(`*`, an asterisk) which will match any word in a pattern (`alpha * charlie`).

##### Parameters

*   `tree` ([`Node`][node])
    — tree to search
*   `phrases` (`Array<string>`)
    — phrases to search for
*   `handler` ([`Handler`][api-handler])
    — handle a match
*   `options` ([`Options`][api-options])
    — configuration

###### Returns

Nothing (`undefined`).

### `Handler`

Handle a match (TypeScript type).

###### Parameters

*   `nodes` ([`Array<Node>`][node])
    — match
*   `index` (`number`)
    — index of first node of `nodes` in `parent`
*   `parent` ([`Node`][node])
    — parent of `nodes`
*   `phrase` (`string`)
    — the phrase that matched

###### Returns

Nothing (`undefined`).

### `Options`

Configuration (TypeScript type).

###### Fields

*   `allowApostrophes` (`boolean`, default: `false`)
    — passed to [`nlcst-normalize`][nlcst-normalize]
*   `allowDashes` (`boolean`, default: `false`)
    — passed to [`nlcst-normalize`][nlcst-normalize]
*   `allowLiterals` (`boolean`, default: `false`)
    — include [literal][] phrases

## Types

This package is fully typed with [TypeScript][].
It exports the additional types [`Handler`][api-handler] and
[`Options`][api-options].

## 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, `nlcst-search@^4`,
compatible with Node.js 16.

## Related

*   [`nlcst-normalize`](https://github.com/syntax-tree/nlcst-normalize)
    — normalize a word for easier comparison
*   [`nlcst-is-literal`](https://github.com/syntax-tree/nlcst-is-literal)
    — check whether a node is meant literally

## 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, organization, or community you agree to
abide by its terms.

## License

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

<!-- Definitions -->

[build-badge]: https://github.com/syntax-tree/nlcst-search/workflows/main/badge.svg

[build]: https://github.com/syntax-tree/nlcst-search/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/nlcst-search.svg

[coverage]: https://codecov.io/github/syntax-tree/nlcst-search

[downloads-badge]: https://img.shields.io/npm/dm/nlcst-search.svg

[downloads]: https://www.npmjs.com/package/nlcst-search

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

[size]: https://bundlejs.com/?q=nlcst-search

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

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

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

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

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

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

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

[esmsh]: https://esm.sh

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

[license]: license

[author]: https://wooorm.com

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

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

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

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

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

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

[literal]: https://github.com/syntax-tree/nlcst-is-literal

[nlcst-normalize]: https://github.com/syntax-tree/nlcst-normalize

[api-search]: #searchtree-phrases-handler-options

[api-handler]: #handler

[api-options]: #options

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