ships.Function.getModulesByName

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

Function: getModulesByName()

getModulesByName(name, modules?): OutfittingModule[]

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

Every module with a given display name, in catalogue order.

Parameters

name

string

The display name as the registry spells it, e.g. "Pulse Laser". Leading/trailing whitespace and case are ignored, but matching is otherwise exact.

modules?

readonly OutfittingModule[] = ALL_MODULES

Optional subset to search (see getModuleBySymbol).

Returns

OutfittingModule[]

All matching modules — the name is shared across sizes, ratings and (for armour) hulls, so this returns an array. Empty if none match. The input array is not modified.

Throws

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

Example

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

getModulesByName('pulse laser').length; // -> every size/mount variant