Skip to main content

lookupDirectionalAbbreviation()

lookupDirectionalAbbreviation(cardinalDirection)

function lookupDirectionalAbbreviation<D>(cardinalDirection): DirectionAbbreviationRecord[D]

Given a directional name, returns the corresponding 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
cardinalDirectionD

Returns

DirectionAbbreviationRecord[D]

lookupDirectionalAbbreviation(input)

function lookupDirectionalAbbreviation(input): DirectionalAbbreviation | null

Given a possible cardinal direction, attempt to return the corresponding abbreviation.

Parameters

ParameterType
inputunknown

Returns

DirectionalAbbreviation | null