# transit-char-service

> ## Installation

Latest version **1.0.1** (published 2022-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install transit-char-service
pnpm add transit-char-service
yarn add transit-char-service
bun add transit-char-service
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-04-05 |
| First published | 2022-04-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | sunlikera |
| Maintainers | sunlikera |

## Links

- npm: https://www.npmjs.com/package/transit-char-service
- Repository: https://github.com/sunlikera/CharChecker
- Homepage: https://github.com/sunlikera/CharChecker#readme
- Issues: https://github.com/sunlikera/CharChecker/issues
- npm.io page: https://npm.io/package/transit-char-service

## Dependencies (2)

- [mocha](https://npm.io/package/mocha.md) ^9.2.2
- [expect.js](https://npm.io/package/expect.js.md) ^0.3.1

## Recent versions

- 1.0.1 (latest) — 2022-04-05
- 1.0.0 — 2022-04-05

## README

# Transit char service

## Installation

```
npm i transit-char-service
```

## Usage

This javascript package returns combination all words with all kinds of similar english chars.

For examle: in word "Хай" char "Х" can be "X" in english and char "а" can be similar char "a" in english.

This package has two main methods `detect()` method (which returns array of objects `[ { char: 'С', index: 0 } ]`) and `getCorrectedText(text, dictionary)` method (which returns corrected text). 
You can use RU and ENG dictionaries for finding incorrect chars.

## Example

```javascript
let service = new CharService()
let dictionaries = new DictionaryLanguages()
//for finding english chars at russian text
let detectEngCharsDictionary = dictionaries.ENG

service.setDictionary(detectEngCharsDictionary)
service.setText('Xай')
let detected = service.detect()
let correctedText = service.getCorrectedText()
```

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