Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

caverphone

tcort51ISC1.0.0TypeScript support: definitely-typed

A JavaScript implementation of the Caverphone 2.0 (aka Caverphone Revised) phonetic matching algorithm.

caverphone, phonetic, matching, algorithm

readme

caverphone

A JavaScript implementation of the Caverphone 2.0 (aka Caverphone Revised) phonetic matching algorithm.

Example

npm install --save caverphone
'use strict';

const caverphone = require('caverphone');

const result = caverphone('word');
// result of caverphone('word') is 'WT11111111'

Acknowledgements

Original Source of the Caverphone 2.0 algorithm description: Caversham Project at the University of Otago