|
5 | 5 | > Validate & parse UK postcodes |
6 | 6 |
|
7 | 7 | [](https://circleci.com/gh/ideal-postcodes/postcode) |
8 | | -[](https://coveralls.io/github/ideal-postcodes/postcode?branch=master) |
| 8 | +[](https://coveralls.io/github/ideal-postcodes/postcode?branch=master) |
9 | 9 | [](https://david-dm.org/ideal-postcodes/postcode) |
10 | 10 | [](https://bundlephobia.com/result?p=postcode) |
11 | 11 | [](https://www.npmjs.com/package/postcode) |
@@ -116,49 +116,9 @@ Postcode.toSector("Sw1A 2aa"); // => "SW1A 2" |
116 | 116 | Postcode.toUnit("Sw1A 2aa"); // => "AA" |
117 | 117 | ``` |
118 | 118 |
|
119 | | -### Older API |
| 119 | +### Legacy API |
120 | 120 |
|
121 | | -Below documents the old validation API, which continues to be supported. |
122 | | - |
123 | | -Create an instance of Postcode to perform utility methods, like so: |
124 | | - |
125 | | -```javascript |
126 | | -const Postcode = require("postcode"); |
127 | | - |
128 | | -const postcode = new Postcode("ec1v9lb"); |
129 | | -``` |
130 | | - |
131 | | -Perform simple validations, parsing and normalisation |
132 | | - |
133 | | -```javascript |
134 | | -postcode.valid() // => true |
135 | | -postcode.normalise() // => "EC1V 9LB" |
136 | | - |
137 | | -postcode.outcode() // => "EC1V" |
138 | | -postcode.incode() // => "9LB" |
139 | | -postcode.area() // => "EC" |
140 | | -postcode.district() // => "EC1" |
141 | | -postcode.subDistrict() // => "EC1V" |
142 | | -postcode.sector() // => "EC1V 9" |
143 | | -postcode.unit() // => "LB" |
144 | | -``` |
145 | | - |
146 | | -### Method Overview |
147 | | - |
148 | | -| Postcode | .outcode() | .incode() | .area() | .district() | .subDistrict() | .sector() | .unit() | |
149 | | -|----------|------------|-----------|---------|-------------|----------------|-----------|---------| |
150 | | -| AA9A 9AA | AA9A | 9AA | AA | AA9 | AA9A | AA9A 9 | AA | |
151 | | -| A9A 9AA | A9A | 9AA | A | A9 | A9A | A9A 9 | AA | |
152 | | -| A9 9AA | A9 | 9AA | A | A9 | null | A9 9 | AA | |
153 | | -| A99 9AA | A99 | 9AA | A | A99 | null | A99 9 | AA | |
154 | | -| AA9 9AA | AA9 | 9AA | AA | AA9 | null | AA9 9 | AA | |
155 | | -| AA99 9AA | AA99 | 9AA | AA | AA99 | null | AA99 9 | AA | |
156 | | - |
157 | | -### Misc. Class Methods include |
158 | | - |
159 | | -``` |
160 | | -Postcode.validOutcode(outcode) |
161 | | -``` |
| 121 | +The legacy object based API is documented in [LEGACY.md](LEGACY.md) |
162 | 122 |
|
163 | 123 | ## Definitions |
164 | 124 |
|
|
0 commit comments