astro.Function.permitLockForSystemName

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

Function: permitLockForSystemName()

permitLockForSystemName(name): PermitLock | null

Defined in: src/astro/permit-locks.ts:123

The permit lock that applies to a system name, or null if it is open space.

Checks the exact-name list first, then the region names, so a system that is both individually listed and inside a locked region reports kind: 'system'.

Parameters

name

string

A system name in any casing, with or without surrounding whitespace, e.g. " shinrarta dezhra ". An empty or blank string yields null.

Returns

PermitLock | null

A PermitLock naming the system or region responsible, or null when nothing on the list matches.

Throws

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

Example

import { permitLockForSystemName } from '@elite-dangerous-almanac/core/astro/permit-locks';

permitLockForSystemName('sol');
// -> { kind: 'system', name: 'Sol', id64: 10477373803n }

permitLockForSystemName('Bleia1 DL-Y f26');
// -> { kind: 'region', name: 'Bleia1' }

permitLockForSystemName('Col 285 Sector IX-T d3-31'); // -> null (the bubble's Col 285)