localized-address-format

Localized Address Formatting

Zero-dependency address formatting library.

If you are in need for simply formatting postal addresses in a localized format, this is the right library for you. It is based on code from libaddressinput by Google and uses the same data from their Address Data Service, but in a pruned format which is only a little over 5kb in size.

Usage of the library is very straight forward:

import {formatAddress} from 'localized-address-format';

console.log(formatAddress({
    postalCountry: 'US',
    administrativeArea : 'CA',
    locality: 'San Fransisco',
    //dependentLocality: '',
    postalCode: '94016',
    //sortingCode: '',
    organization: 'Example Org.',
    name: 'Jon Doe',
    addressLines : ['548 Market St'],
}).join('\n'));

This library formats addresses in the local script type by default. If you prefer to use the latin script type, pass latin as second argument to the formatAddress() function.

All fields of the address are optional and can either be left out completely or passed in as empty string or, in the case of addressLines, be an empty array. The format of the resulting address is dependent on the postalCountry.

The formatted address will not include the country itself. Adding the country to the end of the address is up to your application.

Changelog

1.3.1 (2023-03-26)

Bug Fixes

• formats: update address formats to 2023-03-26 (7b1a0f1)