Wondering what’s next for npm?Check out our public roadmap! »

    @sindresorhus/transliterate
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.1 • Public • Published

    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'

    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.

    import transliterate from '@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.

    Related

    Install

    npm i @sindresorhus/transliterate

    DownloadsWeekly Downloads

    452,130

    Version

    1.2.1

    License

    MIT

    Unpacked Size

    17.5 kB

    Total Files

    6

    Last publish

    Collaborators

    • avatar