Reference · Australian country module
formatAustraliaPostfunction
Writes an Australian address as Australia Post asks: the building's name, then the delivery line (unit and level
before the number, the street type abbreviated), then the suburb, state and postcode, both in capitals with no
punctuation. A postal delivery (PO BOX 37) takes the delivery line's place.
Import it
import { formatAustraliaPost } from "@johnmorrisdotca/address-plus/au";Definition
function formatAustraliaPost(address: ParsedAddress, options?: AustraliaPostFormattingOptions): FormattedAddressParameters
| Name | Type | Description |
|---|---|---|
address | ParsedAddress | The address as |
options (optional) | AustraliaPostFormattingOptions | The unit's style, the spacing of the last line, and whether to add AUSTRALIA (see
|
Returns
FormattedAddress
The lines, the same on one line, the delivery line and the last line.
Examples
import { formatAustraliaPost, parseAustralianAddress } from "@johnmorrisdotca/address-plus/au";
const parsedAddress1=parseAustralianAddress("Level 6, 51 Jacobson Street, Brisbane Qld 4000");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(formatAustraliaPost(parsedAddress1).lines);
// → ["LEVEL 6 51 JACOBSON ST","BRISBANE QLD 4000"][ 'LEVEL 6 51 JACOBSON ST', 'BRISBANE QLD 4000' ]What it prints (run when this page was built)