equipment.Function.getSuitBySymbol

@elite-dangerous-almanac/core / equipment / getSuitBySymbol

Function: getSuitBySymbol()

getSuitBySymbol(symbol): Readonly<{ grade: EquipmentGrade; suit: Suit; }> | null

Defined in: src/equipment/suits.ts:123

Resolve the grade-specific Frontier item symbol reported by journal suit events.

Parameters

symbol

string

Item symbol such as "utilitysuit_class3", matched case-insensitively after trimming surrounding whitespace.

Returns

Readonly<{ grade: EquipmentGrade; suit: Suit; }> | null

The owning suit and its numeric grade, or null when unknown.

Throws

If symbol is present and not a string. A nullish symbol is a miss, answered like an unrecognised one.

Example

import { getSuitBySymbol } from '@elite-dangerous-almanac/core/equipment/suits';
getSuitBySymbol('utilitysuit_class3')?.grade; // -> 3