# keyword-mark

> ```bash npm i keyword-mark ```

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

## Install

```sh
npm install keyword-mark
pnpm add keyword-mark
yarn add keyword-mark
bun add keyword-mark
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2023-07-07 |
| First published | 2023-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | jhc |
| Maintainers | yyyymmddhhmmss |
| Keywords | keywords, highlight, mark, keyword |

## Links

- npm: https://www.npmjs.com/package/keyword-mark
- npm.io page: https://npm.io/package/keyword-mark

## 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.0.6 (latest) — 2023-07-07
- 1.0.5 — 2023-07-07
- 1.0.4 — 2023-06-14
- 1.0.3 — 2023-06-08
- 1.0.2 — 2023-05-25
- 1.0.1 — 2023-05-24
- 1.0.0 — 2023-05-24

## README

# keyword-mark

```bash
npm i keyword-mark
```

```javascript
import keywordMark from 'keyword-mark'

/**
 * This function searches for a keyword in a given content and returns the result.
 * @param {string} content
 * @param {string} keyword
 * @param {Object|null} options
 * @param {boolean} options.full - Whether to search for the full word only (default: true).
 * @param {function} options.handle - A function to handle the search result (default: null).
 * @param {boolean} options.ignoreCase - Whether to ignore case when searching (default: false).
 * @param {string} options.tag - The HTML tag to wrap the search result in (default: 'em').
 * @param {boolean} options.split (default: true).
 * @returns {string}
 */
function keywordMark(content, keyword, options = null)
```

## Example
```javascript
const content = 'Lorem ipsum dolor sit amet, consectetuer adIPiscing elit'
const keyword = 'ip ad i'

const result1 = keywordMark(content, 'ip')
const result2 = keywordMark(content, keyword)
const result3 = keywordMark(content, keyword, {
  ignoreCase: true,
})
const result4 = keywordMark(content, keyword, {
  full: false,
})
const result5 = keywordMark(content, keyword, {
  handle(match) {
    return `<small>${match}</small>`
  }
})
const result6 = keywordMark(content, keyword, {
  tag: 'strong'
})
const result7 = keywordMark(content, keyword, {
  ignoreCase: true,
  full: false,
  handle(match) {
    return `<u>${match}</u>`
  }
})

console.log(result1)
//Lorem <em>ip</em>sum dolor sit amet, consectetuer adIPiscing elit

console.log(result2)
//Lorem <em>ip</em>sum dolor s<em>i</em>t amet, consectetuer <em>ad</em>IP<em>i</em>sc<em>i</em>ng el<em>i</em>t

console.log(result3)
//Lorem <em>ip</em>sum dolor s<em>i</em>t amet, consectetuer <em>ad</em><em>IP</em><em>i</em>sc<em>i</em>ng el<em>i</em>t

console.log(result4)
//Lorem <em>ip</em>sum <em>d</em>olor s<em>i</em>t <em>a</em>met, consectetuer <em>ad</em>IP<em>i</em>sc<em>i</em>ng el<em>i</em>t

console.log(result5)
//Lorem <small>ip</small>sum dolor s<small>i</small>t amet, consectetuer <small>ad</small>IP<small>i</small>sc<small>i</small>ng el<small>i</small>t

console.log(result6)
//Lorem <strong>ip</strong>sum dolor s<strong>i</strong>t amet, consectetuer <strong>ad</strong>IP<strong>i</strong>sc<strong>i</strong>ng el<strong>i</strong>t

console.log(result7)
//Lorem <u>ip</u>sum <u>d</u>olor s<u>i</u>t <u>a</u>met, consectetuer <u>ad</u><u>IP</u><u>i</u>sc<u>i</u>ng el<u>i</u>t
```

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