# @types/similarity

> TypeScript definitions for similarity

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

## Install

```sh
npm install @types/similarity
pnpm add @types/similarity
yarn add @types/similarity
bun add @types/similarity
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.2.3 |
| Published | 2023-11-07 |
| First published | 2020-11-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51451 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/similarity
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/similarity
- npm.io page: https://npm.io/package/@types/similarity

## Recent versions

- 1.2.3 (latest) — 2023-11-07
- 1.2.1 (ts3.6) — 2021-07-06
- 1.2.0 (ts3.2) — 2020-11-10
- 1.2.2 — 2023-10-18

## README

# Installation
> `npm install --save @types/similarity`

# Summary
This package contains type definitions for similarity (https://github.com/words/similarity).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/similarity.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/similarity/index.d.ts)
````ts
declare namespace similarity {
    interface Options {
        /**
         * treat casing differences as differences
         */
        sensitive?: boolean | undefined;
    }
}

declare function similarity(left: string, right: string, options?: similarity.Options): number;

export = similarity;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: none

# Credits
These definitions were written by [Christian Murphy](https://github.com/ChristianMurphy).

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