# @nlptools/comparison

> Programmatically create text comparisons, powered by Demo Macro.

Latest version **0.0.1** (published 2024-09-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @nlptools/comparison
pnpm add @nlptools/comparison
yarn add @nlptools/comparison
bun add @nlptools/comparison
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2024-09-04 |
| First published | 2023-05-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 8.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Demo Macro |
| Maintainers | demomacro |
| Keywords | nlp, similarity, diff, comparison |

## Links

- npm: https://www.npmjs.com/package/@nlptools/comparison
- Repository: https://github.com/DemoMacro/nlptools
- Homepage: https://github.com/DemoMacro/nlptools#readme
- Issues: https://github.com/DemoMacro/nlptools/issues
- npm.io page: https://npm.io/package/@nlptools/comparison

## Dependencies (3)

- [diff](https://npm.io/package/diff.md) 5.2.0
- [@nlptools/similarity](https://npm.io/package/@nlptools/similarity.md) 0.0.1
- [@nlptools/segmentation](https://npm.io/package/@nlptools/segmentation.md) 0.0.1

## Recent versions

- 0.0.1 (latest) — 2024-09-04
- 0.0.1-edge.12 — 2023-09-15
- 0.0.1-edge.11 — 2023-08-30
- 0.0.1-edge.10 — 2023-08-27
- 0.0.1-edge.9 — 2023-08-03
- 0.0.1-edge.8 — 2023-08-02
- 0.0.1-edge.7 — 2023-07-19
- 0.0.1-edge.6 — 2023-07-16
- 0.0.1-edge.5 — 2023-07-15
- 0.0.1-edge.4 — 2023-07-15
- 0.0.1-edge.3 — 2023-05-25
- 0.0.1-edge.2 — 2023-05-24
- 0.0.1-edge.1 — 2023-05-23
- 0.0.1-edge.0 — 2023-05-05
- 0.0.0 — 2023-05-03

## README

# @nlptools/comparison

![npm version](https://img.shields.io/npm/v/@nlptools/comparison)
![npm downloads](https://img.shields.io/npm/dw/@nlptools/comparison)
![npm license](https://img.shields.io/npm/l/@nlptools/comparison)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)

> Programmatically create text comparisons, powered by Demo Macro.

## Getting started

```bash
# npm
$ npm install @nlptools/comparison

# yarn
$ yarn add @nlptools/comparison

# pnpm
$ pnpm add @nlptools/comparison
```

## Usage

```ts
// diff
import { createDiffComparison } from "@nlptools/comparison";

const diff = createDiffComparison("Hello, world!", "Hello, world?", {
  // options
  ignoreCase: false,
  lang: "en",
  segmentation: "chars",
});

// similarity
import { createSimilarityComparison } from "@nlptools/comparison";

const similarity = createSimilarityComparison(
  "Hello, world!",
  "Hello, world?",
  {
    // options
    lang: "en",
    threshold: 10,
  },
);
```

## License

- [MIT](LICENSE) © [Demo Macro](https://imst.xyz/)

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