i18n.Function.getExperimentalEffectDescription

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

Function: getExperimentalEffectDescription()

getExperimentalEffectDescription(experimentalEffectSymbol, locale): string | null

Defined in: src/i18n/experimental-effect-descriptions.ts:29

Look up an experimental effect's display description.

Parameters

experimentalEffectSymbol

string

Frontier's experimental-effect id. Matching ignores case and surrounding whitespace.

locale

string

A BCP 47 locale. The current source supplies canonical English only.

Returns

string | null

The localized description, or null when the effect is unknown, has no source description, or the requested locale is unavailable.

Throws

If a present experimentalEffectSymbol or locale is not a string.

Example

import { getExperimentalEffectDescription } from '@elite-dangerous-almanac/core/i18n/experimental-effect-descriptions';

getExperimentalEffectDescription('special_auto_loader', 'en'); // -> 'Reloads the weapon while it continues firing.'
getExperimentalEffectDescription('special_auto_loader', 'fr'); // -> null