commodities.Function.getCommodityBySymbol

@elite-dangerous-almanac/core / commodities / getCommodityBySymbol

Function: getCommodityBySymbol()

getCommodityBySymbol(symbol, commodities?): Commodity | null

Defined in: src/commodities/commodities.ts:144

Look up a commodity by its Frontier symbol / journal id (case-insensitive).

Here, symbol is Frontier's internal item id for the commodity.

Parameters

symbol

string

The internal symbol, e.g. "Platinum", or the lower-cased form the market/journal reports ("platinum"). Leading/trailing whitespace is ignored.

commodities?

readonly Commodity[] = ALL_COMMODITIES

Optional subset to search instead of all 399 commodities — COMMODITIES (standard only), RARE_COMMODITIES, or any array you have filtered yourself. Omit it unless you specifically want to exclude the other registry: the indexed O(1) path is taken only when the argument is omitted or is ALL_COMMODITIES by reference, and every other array — a copy of that same catalogue included — is scanned.

Returns

Commodity | null

The matching Commodity, or null if no commodity 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 { getCommodityBySymbol } from '@elite-dangerous-almanac/core/commodities/commodities';

getCommodityBySymbol('lavianbrandy')?.name; // -> 'Lavian Brandy'