# @laomao800/mark-match

> [![Actions Status](https://github.com/laomao800/mark-match/workflows/package-ci/badge.svg)](https://github.com/laomao800/mark-match/actions) [![codecov](https://codecov.io/gh/laomao800/mark-match/branch/master/graph/badge.svg)](https://codecov.io/gh/laom

Latest version **1.1.2** (published 2023-05-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @laomao800/mark-match
pnpm add @laomao800/mark-match
yarn add @laomao800/mark-match
bun add @laomao800/mark-match
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2023-05-05 |
| First published | 2019-10-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | laomao800 |
| Keywords | mark, match, search, highlight |

## Links

- npm: https://www.npmjs.com/package/@laomao800/mark-match
- Repository: https://github.com/laomao800/mark-match
- Homepage: https://github.com/laomao800/mark-match#readme
- Issues: https://github.com/laomao800/mark-match/issues
- npm.io page: https://npm.io/package/@laomao800/mark-match

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.1.2 (latest) — 2023-05-05
- 1.1.1 — 2020-03-19
- 1.1.0 — 2019-10-21

## README

# mark-match

[![Actions Status](https://github.com/laomao800/mark-match/workflows/package-ci/badge.svg)](https://github.com/laomao800/mark-match/actions)
[![codecov](https://codecov.io/gh/laomao800/mark-match/branch/master/graph/badge.svg)](https://codecov.io/gh/laomao800/mark-match)

## Usage

```js
import { markMatch, markExactMatch, hasMatch, hasExactMatch } from '@laomao800/mark-match'

// Normal match
markMatch('1234567890', '34') // -> '12<mark>34</mark>567890'

// Multiple keyword split by spaces
markMatch('1234567890', '3 6 9') // -> '12<mark>3</mark>45<mark>6</mark>78<mark>9</mark>0'

// Mark match by exact keyword include spaces
markExactMatch('1 2 3 4 5 6 7 8 9', '3 4 5') // -> '1 2 <mark>3 4 5</mark> 6 7 8 9'

// Custom match template
markMatch('1234567890', '34', match => `<span class="keyword">${match}</span>`)
markExactMatch('1234567890', '34', match => `<span class="keyword">${match}</span>`)
// -> '12<span class="keyword">34</span>567890'

// Works like `markMatch` & `markExactMatch` except is return boolean value
hasMatch('1234567890', '3 6 9') // true
hasExactMatch('1234567890', '3 6 9') // false
```

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