Skip to main content

pluckUnitDesignator()

pluckUnitDesignator(designator)

function pluckUnitDesignator<D>(designator): UnitDesignatorsMatch<D>

Given a unit designator abbreviation, returns the corresponding unit designator.

Type Parameters

Type Parameter
D extends | "APARTMENT" | "BUILDING" | "FLOOR" | "SUITE" | "UNIT" | "ROOM" | "DEPARTMENT" | "#"

Parameters

ParameterType
designatorD

Returns

UnitDesignatorsMatch<D>

See

USPS Address Unit Designators

pluckUnitDesignator(designatorAbbreviation)

function pluckUnitDesignator<D>(designatorAbbreviation): UnitDesignatorsMatch<UnitDesignatorRecord[D]>

Type Parameters

Type Parameter
D extends | "FL" | "UNIT" | "#" | "APT" | "BLDG" | "STE" | "RM" | "DEPT"

Parameters

ParameterType
designatorAbbreviationD

Returns

UnitDesignatorsMatch<UnitDesignatorRecord[D]>

pluckUnitDesignator(input)

function pluckUnitDesignator(input): UnitDesignatorsMatch | null

Parameters

ParameterType
inputunknown

Returns

UnitDesignatorsMatch | null