i18n.Function.getSuitName

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

Function: getSuitName()

getSuitName(suit, locale): string | null

Defined in: src/i18n/suits.ts:53

Look up an Odyssey suit's source-backed display name for a locale.

Parameters

suit

string

Either the grade-independent family Suit.family carries, such as "utilitysuit", or one grade's Frontier symbol, such as "utilitysuit_class3" — the form a journal line writes. 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 suit name; the canonical Suit.name for any English tag; or null when the suit 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 game names a suit per family rather than per grade, so every grade of one suit resolves to the same name. The name is the suit's own: the outfitting list prefixes it with the manufacturer — "Remlok Maverick Suit" — which names a shop listing rather than the suit, and is not stored. This lookup bundles no suit stats.

Throws

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

Example

import { getSuitName } from '@elite-dangerous-almanac/core/i18n/suits';

getSuitName('utilitysuit', 'de-DE'); // -> 'Maverick-Anzug'
getSuitName('explorationsuit_class3', 'fr'); // -> 'Combinaison Artemis'
getSuitName('utilitysuit', 'it'); // -> null