materials.Function.getMaterialByElementSymbol

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

Function: getMaterialByElementSymbol()

getMaterialByElementSymbol(elementSymbol, materials?): Material | null

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

Look up a raw material by its chemical element symbol (case-insensitive).

Parameters

elementSymbol

string

The element symbol, e.g. "Fe" or "fe". Leading/trailing whitespace and case are ignored.

materials?

readonly Material[] = ALL_MATERIALS

Optional subset to search (see getMaterialBySymbol).

Returns

Material | null

The matching Material, or null. Only raw materials carry an element symbol, so a manufactured or encoded subset never matches.

Throws

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

Example

import { getMaterialByElementSymbol } from '@elite-dangerous-almanac/core/materials/materials';

getMaterialByElementSymbol('fe')?.name; // -> 'Iron'