commodities.Interface.Commodity

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

Interface: Commodity

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

One tradable commodity in Frontier's market registry.

Remarks

A pure id/name/category record — this is the commodity registry, not a price sheet, so it carries no buy/sell price, supply, demand or producing station. Whether it is a rare good is the Commodity.rare flag; a rare's origin station is not carried (the library has no station registry to key it against).

Properties

category

readonly category: CommodityCategory

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

The market group this commodity is sold under.

---

name

readonly name: string

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

Display name, e.g. "Platinum".

---

rare

readonly rare: boolean

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

Whether this is a rare commodity — a location-specific luxury good produced at a single station — rather than a standard market good.

Remarks

Derived from the catalogue the record lives in: every RARE_COMMODITIES record is true, every COMMODITIES record is false.

---

symbol

readonly symbol: string

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

Frontier's internal symbol, e.g. "Platinum" — the id the market and player journal report (case-insensitively, so "platinum" matches). This is the same field, with the same meaning, as symbol on a ship, module or material, and is the commodity's key.