astro.Function.parseSystemName

@elite-dangerous-almanac/core / astro / parseSystemName

Function: parseSystemName()

parseSystemName(name): SystemNameParts | null

Defined in: astro/system-name.ts:152

Parse a procedural system name into its parts.

The region name may itself contain digits (Col 285 Sector), so parsing walks the suffix backwards from the end. Returns null for anything that is not a well-formed procedural system name.

Parameters

name

string

A system name in any casing, e.g. blae eock kc-c d0.

Returns

SystemNameParts | null

The parsed parts, or null if the name is malformed. A nullish name answers null too: this parser tolerates an absent name, deliberately, so a caller can hand it a field that may not be there. ProceduralSystem.fromName is the stricter factory over the same grammar — it throws TypeError for anything but a string.

Remarks

Parsing does not canonicalize casing: regionName is captured verbatim from the input (parseSystemName('synuefe …').regionName === 'synuefe'). The letters and mass code become numeric indices, so re-formatting them is always canonical, but the region is not — use canonicalizeSystemName (or build a ProceduralSystem via ProceduralSystem.fromName) if you need the region re-cased too.

Throws

If name is present and not a string. Tolerating an absent name is not tolerating any value at all: a number where a name belongs is a caller bug, and it is named rather than left to fail on a method it does not have.