ships.Function.getShipBySymbol

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

Function: getShipBySymbol()

getShipBySymbol(symbol): Ship | null

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

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

Parameters

symbol

string

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

Returns

Ship | null

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

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 symbol is present and not a string. A nullish symbol is a miss, answered the way an unrecognised one is.

Example

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

getShipBySymbol('empire_trader')?.name; // -> 'Imperial Clipper'