Files
site/node_modules/@sindresorhus/transliterate
site-admin 3ac81d5a52
deploy / build-and-publish (push) Successful in 1m37s
the editable site (validation-lab)
2026-11-21 08:03:55 +01:00
..
2026-11-21 08:03:55 +01:00
2026-11-21 08:03:55 +01:00
2026-11-21 08:03:55 +01:00
2026-11-21 08:03:55 +01:00

transliterate

Convert Unicode characters to Latin characters using transliteration

Can be useful for slugification purposes and other times you cannot use Unicode.

Install

npm install @sindresorhus/transliterate

Usage

import transliterate from '@sindresorhus/transliterate';

transliterate('Fußgängerübergänge');
//=> 'Fussgaengeruebergaenge'

transliterate('Я люблю единорогов');
//=> 'Ya lyublyu edinorogov'

transliterate('أنا أحب حيدات');
//=> 'ana ahb hydat'

transliterate('tôi yêu những chú kỳ lân');
//=> 'toi yeu nhung chu ky lan'

transliterate('En–dashes and em—dashes are normalized');
//=> 'En-dashes and em-dashes are normalized'

API

transliterate(string, options?)

Throws a RangeError if any string being normalized contains more than 100 consecutive Unicode combining marks. This includes the input, custom replacement keys, and intermediate results. The total string length is not limited.

string

Type: string

String to transliterate.

options

Type: object

customReplacements

Type: Array<[string, string]> | Map<string, string>
Default: []

Add your own custom replacements.

The replacements are run on the original string before any other transformations. Both the string and the keys are normalized to NFC first, so a key matches canonically equivalent text.

This only overrides a default replacement if you set an item with the same key.

import transliterate from '@sindresorhus/transliterate';

transliterate('Я люблю единорогов', {
	customReplacements: [
		['единорогов', '🦄']
	]
})
//=> 'Ya lyublyu 🦄'

You can also pass a Map:

transliterate('foo & bar', {
	customReplacements: new Map([
		['&', 'and']
	])
})
//=> 'foo and bar'
locale

Type: string

BCP-47 language tag for language-specific transliteration.

When specified, uses language-specific replacement rules for characters that have different transliterations in different languages.

import transliterate from '@sindresorhus/transliterate';

// Swedish: ä→a, ö→o, å→a
transliterate('Räksmörgås', {locale: 'sv'});
//=> 'Raksmorgas'

// German: ä→ae, ö→oe
transliterate('Räksmörgås', {locale: 'de'});
//=> 'Raeksmoergas'

Supported locales

The following locales have specific replacement rules when using the locale option:

  • bg - Bulgarian
  • da - Danish
  • de - German
  • fi - Finnish
  • hu - Hungarian
  • nb - Norwegian Bokmål
  • sr - Serbian
  • sv - Swedish
  • tr - Turkish

The no and nn language codes are aliases for nb.

Supported languages

Most major languages are supported.

This includes special handling for:

  • Arabic
  • Armenian
  • Belarusian
  • Bulgarian
  • Croatian
  • Czech
  • Danish
  • Dhivehi
  • Finnish
  • Georgian
  • German (umlauts)
  • Greek
  • Hungarian
  • Kazakh
  • Kurdish
  • Latin
  • Latvian
  • Lithuanian
  • Macedonian
  • Pashto
  • Persian
  • Polish
  • Romanian
  • Russian
  • Serbian
  • Sindhi
  • Slovak
  • Slovenian
  • Swedish
  • Tatar
  • Turkish
  • Ukrainian
  • Urdu
  • Vietnamese

However, Chinese is currently not supported.