1.0.8 • Published 3 years ago

@jollie/soundex-fr v1.0.8

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

Version Licence Build Coverage Downloads

soundex-fr

Soundex function adapted for french phonetics
Compliant, optimized and small package to get soundex key

For mapping used see https://fr.wikipedia.org/wiki/Soundex#Description

Install

yarn add @jollie/soundex-fr

or

npm install @jollie/soundex-fr

Usage

import soundex from '@jollie/soundex-fr';

// Test equal phonetics
if (soundex('Robert') === soundex('Rupert')) {
  console.log('Equal soundex');
} else {
  console.log('Different soundex');
}

// Output : Equal soundex

Params

soundex(str, length);
PropTypeDefaultNote
strstringRequired fieldInput value
lengthint4Length of soundex key

Return value

Soundex key of length chars