getLocales

Searching for all active objects of language localizations (available for use)

Locales.getLocales()

const value = await Locales.getLocales()

This method retrieves all active language localization objects from the API. It returns a Promise that resolves to an array of LocaleEntity objects.

Example return:

[
  {
    "id": 1764,
    "shortCode": "en",
    "code": "en_US",
    "name": "Bengali",
    "nativeName": "বাংলা",
    "isActive": false,
    "image": "🇦🇨",
    "position": 1
  }
]

Schema

id: number
object identifier
example: 1764

shortCode: string
language code (short)
example: en

code: string
language code with country code
example: en_US

name string
Language name (in English)
example: Bengali

nativeName string
Language name (in native language)
example: বাংলা

isActive: boolean
Flag of usage
example: false

image: string
Graphic image of the language (under development)
example: 🇦🇨

position: ''