# mishear

> Finds possible mishearings for a given word.

Latest version **2.1.3** (published 2015-10-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install mishear
pnpm add mishear
yarn add mishear
bun add mishear
```

## 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 | 2.1.3 |
| Published | 2015-10-18 |
| First published | 2015-09-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jim Kang |
| Maintainers | jimkang |
| Keywords | mishear, mishearing, words, soundalikes, phoneme, metaphone |

## Links

- npm: https://www.npmjs.com/package/mishear
- Repository: https://github.com/jimkang/mishear
- Issues: https://github.com/jimkang/mishear/issues
- npm.io page: https://npm.io/package/mishear

## Dependencies (6)

- [async](https://npm.io/package/async.md) ^0.9.0
- [lodash](https://npm.io/package/lodash.md) ^3.10.1
- [wordpos](https://npm.io/package/wordpos.md) ^0.1.15
- [probable](https://npm.io/package/probable.md) ^1.7.0
- [homophonizer](https://npm.io/package/homophonizer.md) ^1.1.0
- [call-next-tick](https://npm.io/package/call-next-tick.md) ^1.1.2

## Recent versions

- 2.1.3 (latest) — 2015-10-18
- 2.1.2 — 2015-10-11
- 2.1.1 — 2015-10-11
- 2.1.0 — 2015-10-05
- 2.0.0 — 2015-10-05
- 1.0.1 — 2015-09-28
- 1.0.0 — 2015-09-25

## README

mishear
=======

Finds possible mishearings for a given word.

Installation
------------

    npm install mishear

(This can take a while because its dependencies need to build a few databases.)

Usage
-----

    var createMishear = require('mishear');
    var mishear = createMishear();

    mishear('running', logMishearings);

    function logMishearings(error, words) {
      if (error) {
        console.log(error);
      }
      else {
        console.log(words);
      }
    }

Output:

    ['RUINING', 'RAINING', 'REIGNING', 'RENEWING']

You can pass to `createMishear` an instance of [probable](https://github.com/jimkang/probable) that is configured the way you want. This is useful for producing deterministic results for tests.

You can try running it from a terminal by running `node tools/run-mishear.js <your word here>`.

Tests
-----

Run tests with `make test`.

License
-------

The MIT License (MIT)

Copyright (c) 2015 Jim Kang

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

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