astro.Function.getCodexRegion

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

Function: getCodexRegion()

getCodexRegion(id): CodexRegion | null

Defined in: src/astro/codex-region.ts:148

Look up a region by its id.

Parameters

id

number

Region id, 1–42.

Returns

CodexRegion | null

The CodexRegion, or null if id is 0 (outside the map) or otherwise unknown.

Example

import { getCodexRegion } from '@elite-dangerous-almanac/core/astro/codex-region';

getCodexRegion(18)?.name; // -> 'Inner Orion Spur'