# fast-levenshtein

**Repository Path**: ArkTSCentralRepository/fast-levenshtein

## Basic Information

- **Project Name**: fast-levenshtein
- **Description**: fast-levenshtein 是一个 ArkTS 实现的 Levenshtein 算法库，支持基于地区的字符串比较，适用于计算两个字符串之间的编辑距离。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-21
- **Last Updated**: 2024-11-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# fast-levenshtein
基于[fast-levenshtein](https://www.npmjs.com/package/fast-levenshtein)原库3.0.0版本进行适配, 所有功能代码已经转换为`ArkTS`文件

## Install
```sh
ohpm install fast-levenshtein
```

## Description

fast-levenshtein - Levenshtein algorithm in AtkTS.

An ArkTS implementation of the [Levenshtein algorithm](http://en.wikipedia.org/wiki/Levenshtein_distance) with locale-specific collator support. This uses [fastest-levenshtein](https://github.com/ka-weihe/fastest-levenshtein) under the hood.

## Features

* Locale-sensitive string comparisons if needed.
* Comprehensive test suite.

## Examples

**Default usage**

```typescript
import levenshtein from 'fast-levenshtein';

let distance = levenshtein.get('back', 'book');   // 2

distance = levenshtein.get('我愛你', '我叫你');   // 1
```

**Locale-sensitive string comparisons**

It supports using [Intl.Collator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Collator) for locale-sensitive  string comparisons:

```typescript
import levenshtein from 'fast-levenshtein';

levenshtein.get('mikailovitch', 'Mikhaïlovitch', { useCollator: true});
// 1
```

## Performance

This uses [fastest-levenshtein](https://github.com/ka-weihe/fastest-levenshtein) under the hood.

## Contributing

If you wish to submit a pull request please update and/or create new tests for any changes you make and ensure the grunt build passes.

See [CONTRIBUTING.md](https://github.com/hiddentao/fast-levenshtein/blob/master/CONTRIBUTING.md) for details.

## License

MIT - see [LICENSE.md](https://github.com/hiddentao/fast-levenshtein/blob/master/LICENSE.md)