materials.Function.getMaterialBySymbol

@elite-dangerous-almanac/core / materials / getMaterialBySymbol

Function: getMaterialBySymbol()

getMaterialBySymbol(symbol, materials?): Material | null

Defined in: src/materials/materials.ts:218

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

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

Parameters

symbol

string

The internal symbol, e.g. "GridResistors", or the lower-cased form the player journal reports ("gridresistors"). Leading/trailing whitespace and case are ignored.

materials?

readonly Material[] = ALL_MATERIALS

Optional subset to search instead of all 146 materials — RAW_MATERIALS, MANUFACTURED_MATERIALS, ENCODED_MATERIALS, or any array you have filtered yourself. Omit it unless you specifically want to exclude the rest: the indexed O(1) path is taken only when the argument is omitted or is ALL_MATERIALS by reference, and every other array — a copy of that same catalogue included — is scanned.

Returns

Material | null

The matching Material, or null if no material 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 { getMaterialBySymbol } from '@elite-dangerous-almanac/core/materials/materials';

getMaterialBySymbol('temperedalloys')?.name; // -> 'Tempered Alloys'