astro.Function.resolveNamingRegionOrigin

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

Function: resolveNamingRegionOrigin()

resolveNamingRegionOrigin(name): NamingRegionOrigin | null

Defined in: src/astro/naming-region-origins.ts:108

Resolve a region name to its origin.

Hand-authored regions come from the catalogue; any other name is treated as a procedural sector and its origin synthesised from the sector grid. Returns null only when the name is neither catalogued nor a valid procedural sector.

Parameters

name

string

A region (sector) name in any casing, with optional surrounding whitespace.

Returns

NamingRegionOrigin | null

The region origin, or null if the name cannot be resolved.

Throws

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

Example

import { resolveNamingRegionOrigin } from '@elite-dangerous-almanac/core/astro/naming-region-origins';

resolveNamingRegionOrigin('Pleiades Sector'); // catalogued, hand-authored origin
resolveNamingRegionOrigin('Synuefe');         // origin derived from its grid position
resolveNamingRegionOrigin('not a region');    // -> null