Reference · Parsing, formatting and shared types
formatUSPSfunction
Writes a parsed address the way USPS Publication 28 asks: capitals, standard abbreviations, the unit on the street line, and the city, state and ZIP+4 on the last.
Import it
import { formatUSPS } from "@johnmorrisdotca/address-plus";Definition
function formatUSPS(address: ParsedAddress, options?: USPSFormattingOptions): FormattedAddressParameters
| Name | Type | Description |
|---|---|---|
address | ParsedAddress | The address, as |
options (optional) | USPSFormattingOptions | USPS settings (see |
Returns
FormattedAddress
The address as lines and as one line.
Examples
import { formatUSPS, parseLocation } from "@johnmorrisdotca/address-plus";
const parsedAddress1=parseLocation("123 Main Street Apt 4, Anytown, NY 12345");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(formatUSPS(parsedAddress1).lines);
// → ["123 MAIN ST APT 4","ANYTOWN NY 12345"][ '123 MAIN ST APT 4', 'ANYTOWN NY 12345' ]What it prints (run when this page was built)