Light

kartik1998 / phonetics Goto Github PK

7.0 2.0 0.0 79 KB

A nodejs library for phonetic string matching which supports phonetic algorithms like soundex, metaphone and double-metaphone.

License: MIT License

TypeScript 100.00%

metaphone double-metaphone-algorithms metaphone-match soundex phonetics nodejs

phonetics's Introduction

A nodejs library for phonetic string matching which exposes: soundex, metaphone and double-metaphone algorithms.

Usage

Soundex

const Phonetics = require('phonetics');
// or import * as Phonetics from 'phonetics'
console.log(Phonetics.soundex('phonetic'));

output: p532

Soundex match

const Phonetics = require('phonetics');
console.log(Phonetics.soundexMatch('phonetic', 'phonetics'));

output: true

Metaphone

const Phonetics = require('phonetics');
console.log(Phonetics.metaphone('phonetic'));

output: FNTK

Metaphone match

const Phonetics = require('phonetics');
console.log(Phonetics.metaphoneMatch('phonetic', 'phonetics'));

output: false

Double Metaphone

const Phonetics = require('phonetics');
console.log(Phonetics.doubleMetaphone('phonetic'));

output: [ 'FNTK', 'FNTK' ]

Double Metaphone match

const Phonetics = require('phonetics');
console.log(Phonetics.doubleMetaphoneMatch('phonetic', 'phonetics'));

output: false

phonetics's People

Contributors

Stargazers

Watchers

phonetics's Issues

Just wondering: Should there be a .d.ts file?

If I use require rather than import, const Phonetics = require('phonetics');, my Typescript compiles and runs happily.

If I try to use the new import from syntax, Typescript complains:

src/new/episodesdb.ts:32:23 - error TS7016: Could not find a declaration file for module 'phonetics'. 'C:/Users/keshlam/jovo/new-sounds-on-demand/node_modules/phonetics/build/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/phonetics` if it exists or add a new declaration (.d.ts) file containing `declare module 'phonetics';`

32 import Phonetics from 'phonetics'
                         ~~~~~~~~~~~

I believe I get a similar error if I try import doubleMetaphone from 'phonetics'.

The workaround, obviously, is to use the require syntax. But if we could support both, that would probably be a Good Thing.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.