materials.Function.getMaterialByName

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

Function: getMaterialByName()

getMaterialByName(name, materials?): Material | null

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

Look up a material by its display name (case-insensitive).

Parameters

name

string

The display name as the catalogue spells it, e.g. "Grid Resistors". 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 if no material has that name.

Throws

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

Example

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

getMaterialByName('imperial shielding')?.grade; // -> 5