# soundex

> Generate a soundex index for a word.

Latest version **0.2.1** (published 2013-05-12) · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2013-05-12 |
| First published | 2013-04-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Louis T. |
| Maintainers | louist |
| Keywords | soundex, index, text, phonetic, algorithm |

## Links

- npm: https://www.npmjs.com/package/soundex
- Repository: https://github.com/LouisT/node-soundex
- npm.io page: https://npm.io/package/soundex

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 0.2.1 (latest) — 2013-05-12
- 0.2.0 — 2013-04-28
- 0.1.1 — 2013-04-28
- 0.1.0 — 2013-04-28

## README

Soundex (v0.2.1)
======

Install: npm install soundex
    
This project is [Unlicensed](http://unlicense.org/ "Title").
In other words, I don't care what you do with it.
However, if you make something interesting, I would like to check it out.

Information:
------
Well, the wiki article probably says enough. Find it [here](http://en.wikipedia.org/wiki/Soundex "Title").

    NOTE: I've completely changed the way this works for better scaling support.
Usage:
------
    NOTE: For long words/strings, you can pass a second argument to scale the results.
          Example: Soundex('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla interdum.',true);
          Returns: L6512534623532522336312252435453 // 32 chars long: ~~(length*2/3.5)
 
          To provide MySQL compatability, I've added a third argument:
          Example: Soundex('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla interdum.',true,true);
          Returns: L6512534623532523631252435453635 // 32 chars long, build length.
          MySQL:   SELECT SOUNDEX('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla interdum.'); 

    Node.js:
       var Soundex = require('soundex');
       console.log('Euler: '+Soundex('Euler')+' - Ellery: '+Soundex('Ellery'));
       console.log('Hilbert: '+Soundex('Hilbert')+' - Heilbronn: '+Soundex('Heilbronn'));
       console.log('Lukasiewicz: '+Soundex('Lukasiewicz')+' - Lissajous: '+Soundex('Lissajous'));
       console.log('(default) Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla interdum.\n'+
                 Soundex('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla interdum.',true));
       console.log('(MySQL) Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla interdum.\n'+
                 Soundex('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla interdum.',true,true));

    Browser:
       <script src="./soundex.js"></script>
       <script>
          alert('Euler: '+Soundex('Euler')+' - Ellery: '+Soundex('Ellery'));
          alert('Hilbert: '+Soundex('Hilbert')+' - Heilbronn: '+Soundex('Heilbronn'));
          alert('Lukasiewicz: '+Soundex('Lukasiewicz')+' - Lissajous: '+Soundex('Lissajous'));
          alert('(default) Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla interdum.\n'+
                 Soundex('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla interdum.',true));
          alert('(MySQL) Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla interdum.\n'+
                 Soundex('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla interdum.',true,true));
       </script>

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