umlaut-escape
v1.0.1
Published
Escape umlauts and other special characters in a string. Converts them into HTML entities. Useful when searching for a string in HTML content.
Downloads
12
Maintainers
Readme
escape-umlaut
Description
escape-umlaut
is a small JavaScript package that provides a single function for escaping special characters like umlauts (e.g. õ, ä, ö, ü) in a given string. The special characters are replaced with their respective HTML entities. For a full list of currently supported HTML entities, see the Current special characters map at the end of this README.
Installation
You can install this package via npm:
npm install umlaut-escape
Usage
Import the escapeUmlaut function and use it to escape special characters in a string:
import { escapeUmlaut } from "umlaut-escape";
const inputString = "Hällo Wörld";
const escapedString = escapeUmlaut(inputString);
console.log(escapedString); // Output: 'Hällo WÖrld'
API
escapeUmlaut(input: string): string
This function takes a string input as its parameter and returns a new string with special characters, such as umlauts (ä, ö, ü), replaced with their respective non-special characters.
License
This package is released under the MIT License. See the LICENSE file for more details.
Issues
If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository.
Author
This package was created by Toomas Jaska.
Changelog
See the CHANGELOG.md file for details about changes and version history.
Current special characters map
| Character | HTML Entity |
| --------- | ----------- |
| Ÿ | Ÿ
|
| ÿ | ÿ
|
| Ü | Ü
|
| ü | ü
|
| Ö | Ö
|
| ö | ö
|
| Ï | Ï
|
| ï | ï
|
| Ë | Ë
|
| ë | ë
|
| Ä | Ä
|
| ä | ä
|
| À | À
|
| Á | Á
|
| Â | Â
|
| Ã | Ã
|
| Å | Å
|
| Æ | Æ
|
| Ç | Ç
|
| È | È
|
| É | É
|
| Ê | Ê
|
| Ì | Ì
|
| Í | Í
|
| Î | Î
|
| Ð | Ð
|
| Ñ | Ñ
|
| Ò | Ò
|
| Ó | Ó
|
| Ô | Ô
|
| Õ | Õ
|
| Ø | Ø
|
| Œ | Œ
|
| Ù | Ù
|
| Ú | Ú
|
| Û | Û
|
| Ý | Ý
|
| Þ | Þ
|
| à | à
|
| á | á
|
| â | â
|
| ã | ã
|
| å | å
|
| æ | æ
|
| ç | ç
|
| è | è
|
| é | é
|
| ê | ê
|
| ì | ì
|
| í | í
|
| ð | ð
|
| ñ | ñ
|
| ò | ò
|
| ó | ó
|
| ô | ô
|
| õ | õ
|
| ø | ø
|
| œ | œ
|
| ù | ù
|
| ú | ú
|
| û | û
|
| ý | ý
|
| þ | þ
|
| Š | Š
|
| š | š
|
| Č | Č
|
| č | č
|