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
Parameter | Type |
---|---|
directionalAbbreviation | A |
Returns
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
Parameter | Type |
---|---|
directionalAbbreviation | A |
Returns
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
Parameter | Type |
---|---|
directionalName | D |
Returns
DirectionalMatch
<DirectionAbbreviationRecord
[D
]>
lookupDirectional(input)
function lookupDirectional(input): DirectionalMatch | null
Parameters
Parameter | Type |
---|---|
input | unknown |
Returns
DirectionalMatch
| null