i18n.Function.getShipName

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

Function: getShipName()

getShipName(symbol, locale): string | null

Defined in: src/i18n/ships.ts:32

Look up a ship hull's source-backed display name.

Parameters

symbol

string

Frontier's ship symbol. Matching ignores case and surrounding whitespace.

locale

string

A BCP 47 locale. Regional tags fall back to their supported language.

Returns

string | null

The explicit localized name, or null for an unknown ship, unsupported locale, or unavailable translation. A source-backed spelling may be identical to English.

Throws

If a present symbol or locale is not a string.

Example

import { getShipName } from '@elite-dangerous-almanac/core/i18n/ships';

getShipName('empire_trader', 'fr-FR'); // -> 'Imperial Clipper'
getShipName('empire_trader', 'de'); // -> null