1.0.7 • Published 4 years ago

@jellyfish-commuting/soundex-fr v1.0.7

Weekly downloads
18
License
MIT
Repository
github
Last release
4 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 @jellyfish-commuting/soundex-fr

or

npm install @jellyfish-commuting/soundex-fr

Usage

import soundex from '@jellyfish-commuting/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

1.0.7

4 years ago

1.0.6

4 years ago