astro.Function.getHandAuthoredRegionOrigin

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

Function: getHandAuthoredRegionOrigin()

getHandAuthoredRegionOrigin(name): NamingRegionOrigin | null

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

Look up a hand-authored named region's catalogued origin.

Parameters

name

string

A named region in any casing, with optional surrounding whitespace.

Returns

NamingRegionOrigin | null

Its canonical origin record, or null when it is not catalogued.

Throws

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

Example

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

getHandAuthoredRegionOrigin('  PLEIADES SECTOR ')?.name; // -> 'Pleiades Sector'
getHandAuthoredRegionOrigin('Synuefe');                  // -> null