# node-address-format

**Repository Path**: mirrors_Dexus/node-address-format

## Basic Information

- **Project Name**: node-address-format
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-05-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

node-address-format
-------------------

Simple address formatting for the masses

#### Usage

```js
require('address-format')({
    address: '1234 Some St.',
    address2: 'Floor #67',
    address3: 'Unit #123',
    city: 'San Francisco',
    subdivision: 'CA',
    postalCode: '94105',
    countryCode: 'US'
})
```
will output
```js
[
  '1234 Some St.',
  'Floor #67',
  'Unit #123',
  'San Francisco, CA 94105'
]
```

If a line does not have any information, it will be omitted.

No fields are required to call the formatter, but the only property that will invoke some logic is the [ISO 3166 Alpha-2 country code](http://www.iso.org/iso/country_codes.htm), for which an index can be found [here](https://www.iso.org/obp/ui/#search).

#### Use in Node.js

```sh
npm install node-address --save
```

#### Building for use in browser

I've included a build script for a standalone browserify module.  To build, simply run the following from CLI:

```sh
npm install
npm run build
```

This will `browserify` to `dist/address-format.js` and uglify to `dist/address-format.min.js`.  Include whichever you like.

#### Contributions

Gladly accepting contributions, hopefully in the form of additional countries.  Regardless of current tests being a bit naive, please include tests for added countries to ensure the output is as expected.

#### Other implementations

* PHP - [arcreative/php-address-format](https://github.com/arcreative/php-address-format)