Package Exports

@sindresorhus/transliterate

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@sindresorhus/transliterate) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

const transliterate = require('@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'

API

transliterate(string, options?)

string

Type: string

String to transliterate.

options

Type: object

customReplacements

Type: Array<string[]>
Default: []

Add your own custom replacements.

The replacements are run on the original string before any other transformations.

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

const transliterate = require('@sindresorhus/transliterate');

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

Supported languages

Most major languages are supported.

This includes special handling for:

Arabic
Armenian
Czech
Danish
Dhivehi
Georgian
German (umlauts)
Greek
Hungarian
Latin
Latvian
Lithuanian
Macedonian
Pashto
Persian
Polish
Romanian
Russian
Serbian
Slovak
Swedish
Turkish
Ukrainian
Urdu
Vietnamese

However, Chinese is currently not supported.

slugify - Slugify a string

@sindresorhus/transliterate