equipment.Function.getSuitByFamily

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

Function: getSuitByFamily()

getSuitByFamily(family): Suit | null

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

Look up a suit model by its grade-independent family, case-insensitively.

Parameters

family

string

Family such as "utilitysuit", matched case-insensitively after trimming surrounding whitespace.

Returns

Suit | null

The frozen suit record, or null when unknown.

Throws

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

Example

import { getSuitByFamily } from '@elite-dangerous-almanac/core/equipment/suits';
getSuitByFamily('utilitysuit')?.name; // -> 'Maverick Suit'