@marketto/diacritic-remover

diacritic-remover

Typescript library to handle and remove diacritics from strings

INSTALLATION

npm i -s @marketto/diacritic-remover

NodeJs

const DiaCriticRemover = require('@marketto/diacritic-remover');
const diacriticRemover = new DiacriticRemover(); //It loads all diacritics by default

ES6

import DiaCriticRemover from '@marketto/diacritic-remover';
const diacriticRemover = new DiacriticRemover(); //It loads all diacritics by default

TypeScript

import DiaCriticRemover from '@marketto/diacritic-remover';
const diacriticRemover = new DiacriticRemover(); //It loads all diacritics by default

Script

<script src="https://unpkg.com/browse/@marketto/diacritic-remover/dist/diacritic-remover.bundle.js"></script>
<script>
    var diacriticRemover = new DiacriticRemover(); //It loads all diacritics by default
</script>

L10N

NodeJs

const i18n_it = require('@marketto/diacritic-remover/i18n/it.json');
const diacriticRemover = new DiacriticRemover(i18n_it);

ES6

import * as i18n_it from '@marketto/diacritic-remover/i18n/it.json';
const diacriticRemover = new DiacriticRemover(i18n_it);

TypeScript

import * as i18n_it from '@marketto/diacritic-remover/i18n/it.json';
const diacriticRemover = new DiacriticRemover(i18n_it);

USAGE

Replace string diacritics

diacriticRemover.replace('àçcèß'); //access

Char diacritic remover

diacriticRemover.à; //a

Char diacritic map

diacriticRemover.matcher.i; //íîïi̇řìįī

Char diacritic matcher (RegExp)

diacriticRemover.validator.a.test('à'); //true
diacriticRemover.validator.a.test('A'); //true
diacriticRemover.validator.e.test('à'); //false

Char diacritic case insensitive matcher(RegExp)

diacriticRemover.insensitiveValidator.a.test('à'); //true
diacriticRemover.insensitiveValidator.a.test('À'); //true
diacriticRemover.insensitiveValidator.A.test('à'); //true
diacriticRemover.insensitiveValidator.A.test('À'); //true

Get diacritics by RegExp

diacriticRemover.matcherBy(/^[au]$/); //áäâàåÄąāãăúûüùůŭųūư

LICENSE

MIT License

DIACRITIC ASSET LICENSE AND AUTHOR

I18n diacritics jsons files, the i18n/i18n_all.const.ts file and the I18N_ALL const, inside dist files, use material from Wikipedia article Diacritic, which is released under the Creative Commons Attribution-Share-Alike License 3.0 (CC-BY-SA 3.0)

AUTHOR

Marco Ricupero