Skip to content

Latest commit

 

History

History
47 lines (39 loc) · 2.61 KB

README.md

File metadata and controls

47 lines (39 loc) · 2.61 KB
Raw

Soundex (v0.2.1)

Install: npm install soundex

This project is Unlicensed. 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.

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>