ships.Function.getModuleBySymbol

@elite-dangerous-almanac/core / ships / getModuleBySymbol

Function: getModuleBySymbol()

getModuleBySymbol(symbol, modules?): OutfittingModule | null

Defined in: src/ships/modules.ts:886

Look up a module by its internal symbol, case-insensitively.

Parameters

symbol

string

The internal identifier, e.g. "Hpt_PulseLaser_Fixed_Small". Leading/trailing whitespace and case are ignored, so the journal's lower-cased form resolves too.

modules?

readonly OutfittingModule[] = ALL_MODULES

Optional subset to search instead of all 1199 modules — CORE_MODULES, INTERNAL_MODULES, HARDPOINT_MODULES, UTILITY_MODULES, or any array you have filtered yourself. Omit it unless you specifically want to exclude the other categories; a symbol is unique across all four.

Returns

OutfittingModule | null

The matching OutfittingModule, or null if no module has that symbol.

Throws

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

Example

import { getModuleBySymbol } from '@elite-dangerous-almanac/core/ships/modules';

getModuleBySymbol('hpt_pulselaser_fixed_small')?.class; // -> 1