0.0.4 • Published 3 years ago

deumlaut v0.0.4

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

Deumlaut

License: MIT npm package downloads size

A lightweight zero dependency libray to replace Umlauts (Diacritics) from your strings.

npm i deumlaut

# or

yarn add deumlaut

Usage

const { deumlaut } = require('deumlaut')

// or

import { deumlaut } from 'deumlaut'

deumlaut('Tschüss') // Tschuess
deumlaut('Çarşı', 'tr') // Carsi

//  For more examples, you can check the "tests" folder.

Parameters

PositionNameDescriptionRequiredType
1TextText to remove diacriticstruestring
2LocaleYour language to parsefalse'de' or 'tr'
3OptionsDeumlaut options. See Options for the detailsfalseDeumlautOptions object

Options

NameTypeDefault ValueDescription
capitalizebooleanfalseCapitalizes the diacritic equilavants.

Supported Languages

  • Currently only German and Turkish are supported.

Contributing

Please check CONTRIBUTING.md

TODO

  • Improve Documentation
  • Add More Unit tests
  • Improve support for other languages

Contributors

Kaan Gökdemir - Author (@kaangokdemir) - kaangokdemir.com

License

MIT