Skip to main content

lookupDirectional()

lookupDirectional(directionalAbbreviation)​

function lookupDirectional<A>(directionalAbbreviation): DirectionalMatch<A>

Given a directional abbreviation, lookup it's corresponding directional name.

Type Parameters​

Type Parameter
A extends DirectionalAbbreviation

Parameters​

ParameterType
directionalAbbreviationA

Returns​

DirectionalMatch<A>

lookupDirectional(directionalAbbreviation)​

function lookupDirectional<A>(directionalAbbreviation): DirectionalMatch<A>

Given a directional abbreviation, lookup it's corresponding directional name.

Type Parameters​

Type Parameter
A extends DirectionalAbbreviation

Parameters​

ParameterType
directionalAbbreviationA

Returns​

DirectionalMatch<A>

lookupDirectional(directionalName)​

function lookupDirectional<D>(directionalName): DirectionalMatch<DirectionAbbreviationRecord[D]>

Given a directional name, lookup it's corresponding directional abbreviation.

Type Parameters​

Type Parameter
D extends | "NORTH" | "EAST" | "SOUTH" | "WEST" | "NORTH EAST" | "NORTH WEST" | "SOUTH EAST" | "SOUTH WEST" | "NORTHEAST" | "NORTHWEST" | "SOUTHEAST" | "SOUTHWEST" | "North" | "East" | "South" | "West" | "North East" | "North West" | "South East" | "South West" | "north east" | "north west" | "south east" | "south west"

Parameters​

ParameterType
directionalNameD

Returns​

DirectionalMatch<DirectionAbbreviationRecord[D]>

lookupDirectional(input)​

function lookupDirectional(input): DirectionalMatch | null

Parameters​

ParameterType
inputunknown

Returns​

DirectionalMatch | null