{"_id":"@azuliani/transliterate","name":"@azuliani/transliterate","dist-tags":{"latest":"2.3.1"},"versions":{"2.3.1":{"name":"@azuliani/transliterate","version":"2.3.1","description":"Convert Unicode characters to Latin characters using transliteration","license":"MIT","repository":{"type":"git","url":"git+https://github.com/azuliani/transliterate.git"},"funding":"https://github.com/sponsors/sindresorhus","author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"https://sindresorhus.com"},"type":"module","exports":{".":{"types":"./index.d.ts","require":"./index.cjs","import":"./index.js"}},"main":"./index.cjs","sideEffects":false,"engines":{"node":">=18"},"scripts":{"build":"tsup","prepare":"test -f dist/index.cjs || (test -d node_modules/tsup && npm run build) || true","prepublishOnly":"npm run build","test":"xo && ava"},"keywords":["transliterate","transliteration","string","deburr","unicode","ascii","text","latin","latinize","convert","replace"],"devDependencies":{"ava":"^6.4.1","tsup":"^8.5.1","xo":"^1.2.2"},"gitHead":"a0433a89eb5eac9e1ca214b696b34d488fc547bd","types":"./index.d.ts","_id":"@azuliani/transliterate@2.3.1","bugs":{"url":"https://github.com/azuliani/transliterate/issues"},"homepage":"https://github.com/azuliani/transliterate#readme","_nodeVersion":"25.5.0","_npmVersion":"11.8.0","dist":{"integrity":"sha512-T3D5tyQLimM7TR8NM+BDqERC5hmR5JK2NuxbGoMncvVRtU3fBJu8+2GNU6g8IBLQD+IICqXj5XTg53dKUlxoOg==","shasum":"36eea921a3ac6321c5c7d8fd2006a3d10b53fec8","tarball":"https://registry.npmjs.org/@azuliani/transliterate/-/transliterate-2.3.1.tgz","fileCount":10,"unpackedSize":91475,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIA7b8UHk0z8nd4pH+MdiSvzYQUvyUVU1UUCrLLQ201p1AiBjqi26rc3kLFWxHur4nkyqgJAn4FZ8pr4KXbUeO6l8HQ=="}]},"_npmUser":{"name":"azuliani","email":"alexanderzuliani@gmail.com"},"directories":{},"maintainers":[{"name":"azuliani","email":"alexanderzuliani@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/transliterate_2.3.1_1770038446358_0.9223473587589752"},"_hasShrinkwrap":false}},"time":{"created":"2026-02-02T13:20:46.216Z","2.3.1":"2026-02-02T13:20:46.505Z","modified":"2026-02-02T13:20:46.857Z"},"maintainers":[{"name":"azuliani","email":"alexanderzuliani@gmail.com"}],"description":"Convert Unicode characters to Latin characters using transliteration","homepage":"https://github.com/azuliani/transliterate#readme","keywords":["transliterate","transliteration","string","deburr","unicode","ascii","text","latin","latinize","convert","replace"],"repository":{"type":"git","url":"git+https://github.com/azuliani/transliterate.git"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"https://sindresorhus.com"},"bugs":{"url":"https://github.com/azuliani/transliterate/issues"},"license":"MIT","readme":"# @azuliani/transliterate\n\n> Convert Unicode characters to Latin characters using [transliteration](https://en.wikipedia.org/wiki/Transliteration)\n\nThis is a fork of [@sindresorhus/transliterate](https://github.com/sindresorhus/transliterate) that adds CommonJS support. The original package is ESM-only, which can be problematic in some environments.\n\nCan be useful for [slugification](https://github.com/sindresorhus/slugify) purposes and other times you cannot use Unicode.\n\n## Install\n\n```sh\nnpm install @azuliani/transliterate\n```\n\n## Usage\n\n```js\nimport transliterate from '@azuliani/transliterate';\n\ntransliterate('Fußgängerübergänge');\n//=> 'Fussgaengeruebergaenge'\n\ntransliterate('Я люблю единорогов');\n//=> 'Ya lyublyu edinorogov'\n\ntransliterate('أنا أحب حيدات');\n//=> 'ana ahb hydat'\n\ntransliterate('tôi yêu những chú kỳ lân');\n//=> 'toi yeu nhung chu ky lan'\n\ntransliterate('En–dashes and em—dashes are normalized');\n//=> 'En-dashes and em-dashes are normalized'\n```\n\n## API\n\n### transliterate(string, options?)\n\n#### string\n\nType: `string`\n\nString to transliterate.\n\n#### options\n\nType: `object`\n\n##### customReplacements\n\nType: `Array<string[]> | Map<string, string>`\\\nDefault: `[]`\n\nAdd your own custom replacements.\n\nThe replacements are run on the original string before any other transformations.\n\nThis only overrides a default replacement if you set an item with the same key.\n\n```js\nimport transliterate from '@azuliani/transliterate';\n\ntransliterate('Я люблю единорогов', {\n\tcustomReplacements: [\n\t\t['единорогов', '🦄']\n\t]\n})\n//=> 'Ya lyublyu 🦄'\n```\n\nYou can also pass a `Map`:\n\n```js\ntransliterate('foo & bar', {\n\tcustomReplacements: new Map([\n\t\t['&', 'and']\n\t])\n})\n//=> 'foo and bar'\n```\n\n##### locale\n\nType: `string`\n\n[BCP-47](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag) language tag for language-specific transliteration.\n\nWhen specified, uses language-specific replacement rules for characters that have different transliterations in different languages.\n\n```js\nimport transliterate from '@azuliani/transliterate';\n\n// Swedish: ä→a, ö→o, å→a\ntransliterate('Räksmörgås', {locale: 'sv'});\n//=> 'Raksmorgas'\n\n// German: ä→ae, ö→oe\ntransliterate('Räksmörgås', {locale: 'de'});\n//=> 'Raeksmoergas'\n```\n\n### Supported locales\n\nThe following locales have specific replacement rules when using the `locale` option:\n\n- `da` - Danish\n- `de` - German\n- `hu` - Hungarian\n- `nb` - Norwegian Bokmål\n- `sr` - Serbian\n- `sv` - Swedish\n- `tr` - Turkish\n\n## Supported languages\n\nMost major languages are supported.\n\nThis includes special handling for:\n\n- Arabic\n- Armenian\n- Czech\n- Danish\n- Dhivehi\n- Georgian\n- German (umlauts)\n- Greek\n- Hungarian\n- Latin\n- Latvian\n- Lithuanian\n- Macedonian\n- Pashto\n- Persian\n- Polish\n- Romanian\n- Russian\n- Serbian\n- Slovak\n- Swedish\n- Turkish\n- Ukrainian\n- Urdu\n- Vietnamese\n\nHowever, Chinese is [currently not supported](https://github.com/sindresorhus/transliterate/issues/1).\n\n## Related\n\n- [slugify](https://github.com/sindresorhus/slugify) - Slugify a string\n","readmeFilename":"readme.md","_rev":"1-5484a8431903bb0119a51dfe9646639c"}