pluckDirectionalName()
pluckDirectionalName(directionalAbbreviation)
function pluckDirectionalName<C>(directionalAbbreviation): DirectionalAbbreviationRecord[Uppercase<C>]
Given a directional abbreviation, returns the corresponding direction.
Type Parameters
| Type Parameter |
|---|
C extends | DirectionalAbbreviation | "n" | "e" | "s" | "w" | "ne" | "nw" | "se" | "sw" |
Parameters
| Parameter | Type |
|---|---|
directionalAbbreviation | C |
Returns
DirectionalAbbreviationRecord[Uppercase<C>]
pluckDirectionalName(input)
function pluckDirectionalName(input): DirectionalName | null
Given a possible directional abbreviation or name, attempt to return the corresponding direction.
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
DirectionalName | null