https://github.com/chrisbuttery/is-aus-postcode
Validate an Australian postcode
https://github.com/chrisbuttery/is-aus-postcode
australian postcode validation
Last synced: 5 months ago
JSON representation
Validate an Australian postcode
- Host: GitHub
- URL: https://github.com/chrisbuttery/is-aus-postcode
- Owner: chrisbuttery
- License: mit
- Created: 2018-07-26T05:37:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-07T04:06:18.000Z (over 6 years ago)
- Last Synced: 2025-06-30T04:48:22.801Z (7 months ago)
- Topics: australian, postcode, validation
- Language: JavaScript
- Size: 15.6 KB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
# is-aus-postcode
Validate an Australian postcode.
### Install
```js
yarn add is-aus-postcode
npm i is-aus-postcode
```
### Usage
```js
var isAusPostcode = require('is-aus-postcode').default
isAusPostcode("2300") // true
isAusPostcode("0100") // false
isAusPostcode("0230") // true
```
### Reference
| State | Codes |
| :---- | :---- |
| New South Wales | 1000–2599, 2620–2899, 2921–2999 |
| Victoria | 3000–3999, 8000–8999 |
| Queensland | 4000–4999, 9000–9999 |
| South Australia | 5000–5999 |
| Western Australia | 6000–6999 |
| Tasmania | 7000–7999 |
| Australian Capital Territory | 0200–0299, 2600–2619, 2900–2920 |
| Northern Territory | 0800–0999 |
Reference taken from the [Australia Post - Standard Postcode File (PC001)](https://postcode.auspost.com.au/free_display.html?id=1).
[npm-image]: https://img.shields.io/npm/v/is-aus-postcode.svg?style=flat-square
[npm-url]: https://npmjs.org/package/is-aus-postcode
[travis-image]: https://img.shields.io/travis/chrisbuttery/is-aus-postcode.svg?style=flat-square
[travis-url]: https://travis-ci.org/chrisbuttery/is-aus-postcode