ships.Function.getShipByName

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

Function: getShipByName()

getShipByName(name): Ship | null

Defined in: src/ships/ships.ts:208

Look up a ship by display name, case-insensitively.

Parameters

name

string

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

Returns

Ship | null

The matching Ship, or null if no hull has that name.

Remarks

The hulls form one small, unsplit catalogue, so unlike module, material, micro-resource and commodity lookups there is no useful subset argument to narrow.

Throws

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

Example

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

getShipByName('imperial clipper')?.symbol; // -> 'Empire_Trader'