i18n.Function.getModuleName

@elite-dangerous-almanac/core / i18n / getModuleName

Function: getModuleName()

getModuleName(symbol, locale): string | null

Defined in: src/i18n/modules.ts:41

Look up an outfitting module's source-backed display name for a locale.

Parameters

symbol

string

Frontier's module symbol, such as "Int_Hyperdrive_Size6_Class5". Matching ignores case and surrounding whitespace.

locale

string

A BCP 47 language or regional tag, such as "de" or "de-DE"; see GameLocale for how a tag is matched.

Returns

string | null

The localized outfitting name; the canonical OutfittingModule.name for any English tag; or null when the symbol is unknown or the locale is not one of the six this catalogue stores.

Remarks

All six stored locales are complete for this dataset, so a supported locale always answers. The table deduplicates modules that share one name in every locale, which is finer than sharing one canonical English name: the game distinguishes the singular and plural hull alloys, for instance, where English spells both the same. It does not bundle any module stats, so this lookup avoids the ALL_MODULES catalogue.

Throws

If symbol is present and not a string, or locale is not a string. A nullish symbol is a lookup miss and returns null.

Example

import { getModuleName } from '@elite-dangerous-almanac/core/i18n/modules';

getModuleName('Int_Hyperdrive_Size6_Class5', 'de-DE'); // -> 'Frameshiftantrieb'
getModuleName('Int_LargeCargoRack_Size8_class1', 'de'); // -> 'Frachtgestell für Mk II'
getModuleName('Int_Hyperdrive_Size6_Class5', 'it'); // -> null