equipment.Function.getSuitByName - Elite-Dangerous-Almanac/Almanac-Core GitHub Wiki

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

Function: getSuitByName()

getSuitByName(name): Suit | null

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

Look up a suit by its display name, case-insensitively.

Parameters

name

string

Display name such as "Maverick Suit", matched case-insensitively after trimming surrounding whitespace.

Returns

Suit | null

The frozen suit record, or null when unknown.

Throws

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

Example

import { getSuitByName } from '@elite-dangerous-almanac/core/equipment/suits';
getSuitByName('Maverick Suit')?.family; // -> 'utilitysuit'
⚠️ **GitHub.com Fallback** ⚠️