city-translator

Lightweight library for translating city names between English, Persian, and Arabic with auto-detection.

Installation

npm install city-translator

Usage

import CityTranslator from 'city-translator';

const translator = new CityTranslator();

// Translate English to Persian
translator.translate('Tehran', 'fa'); // 'تهران'

// Translate Persian to English
translator.translate('مشهد', 'en'); // 'Mashhad'

// Translate Arabic to Persian
translator.translate('طهران', 'fa'); // 'تهران'

// Auto-detect language (default output: Persian)
translator.translate('Isfahan'); // 'اصفهان'

API

translate(input, targetLang = 'fa')

Translate city name to target language.

translator.translate('Tehran', 'fa'); // 'تهران'
translator.translate('تهران', 'en'); // 'Tehran'

detectLanguage(input)

Detect input language automatically.

translator.detectLanguage('Tehran'); // 'en'
translator.detectLanguage('تهران'); // 'fa'
translator.detectLanguage('طهران'); // 'ar'

search(query, targetLang = 'fa', limit = 10)

Search for cities.

translator.search('teh', 'fa', 5);
// [{ en: 'Tehran', fa: 'تهران', ar: 'طهران' }, ...]

getAllCities(lang = 'fa')

Get all cities in specific language.

translator.getAllCities('fa');
// ['تهران', 'مشهد', 'اصفهان', ...]

Vue Example

<template>
  <div>
    <p>{{ getCity('Tehran') }}</p>
    <input v-model="city" @input="translateCity" />
    <p>{{ result }}</p>
  </div>
</template>

<script>
import CityTranslator from 'city-translator';

export default {
  data() {
    return {
      city: '',
      result: '',
      translator: new CityTranslator()
    };
  },
  methods: {
    getCity(name) {
      return this.translator.translate(name, 'fa');
    },
    translateCity() {
      this.result = this.translator.translate(this.city, 'fa');
    }
  }
};
</script>

Supported Languages

• English (en)
• Persian (fa)
• Arabic (ar)

License

MIT © Mehran Bahrami