Skip to content

Commit ac33b2e

Browse files
committed
docs(Readme): Move out legacy API docs
1 parent 1b5dd56 commit ac33b2e

2 files changed

Lines changed: 46 additions & 43 deletions

File tree

LEGACY.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
### Legacy API
2+
3+
Below documents the old validation API, which continues to be supported.
4+
5+
Create an instance of Postcode to perform utility methods, like so:
6+
7+
```javascript
8+
const Postcode = require("postcode");
9+
10+
const postcode = new Postcode("ec1v9lb");
11+
```
12+
13+
Perform simple validations, parsing and normalisation
14+
15+
```javascript
16+
postcode.valid() // => true
17+
postcode.normalise() // => "EC1V 9LB"
18+
19+
postcode.outcode() // => "EC1V"
20+
postcode.incode() // => "9LB"
21+
postcode.area() // => "EC"
22+
postcode.district() // => "EC1"
23+
postcode.subDistrict() // => "EC1V"
24+
postcode.sector() // => "EC1V 9"
25+
postcode.unit() // => "LB"
26+
```
27+
28+
### Method Overview
29+
30+
| Postcode | .outcode() | .incode() | .area() | .district() | .subDistrict() | .sector() | .unit() |
31+
|----------|------------|-----------|---------|-------------|----------------|-----------|---------|
32+
| AA9A 9AA | AA9A | 9AA | AA | AA9 | AA9A | AA9A 9 | AA |
33+
| A9A 9AA | A9A | 9AA | A | A9 | A9A | A9A 9 | AA |
34+
| A9 9AA | A9 | 9AA | A | A9 | null | A9 9 | AA |
35+
| A99 9AA | A99 | 9AA | A | A99 | null | A99 9 | AA |
36+
| AA9 9AA | AA9 | 9AA | AA | AA9 | null | AA9 9 | AA |
37+
| AA99 9AA | AA99 | 9AA | AA | AA99 | null | AA99 9 | AA |
38+
39+
### Misc. Class Methods include
40+
41+
```javascript
42+
Postcode.validOutcode(outcode)
43+
```

README.md

Lines changed: 3 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
> Validate & parse UK postcodes
66
77
[![CircleCI](https://circleci.com/gh/ideal-postcodes/postcode.svg?style=svg)](https://circleci.com/gh/ideal-postcodes/postcode)
8-
[![Coverage Status](https://coveralls.io/repos/github/ideal-postcodes/postcode/badge.svg?branch=master)](https://coveralls.io/github/ideal-postcodes/postcode?branch=master)
8+
[![Coverage Status](https://coveralls.io/repos/github/ideal-postcodes/postcode/badge.svg?branch=master)](https://coveralls.io/github/ideal-postcodes/postcode?branch=master)
99
[![Dependencies](https://david-dm.org/ideal-postcodes/postcode.svg)](https://david-dm.org/ideal-postcodes/postcode)
1010
[![Size](https://img.shields.io/bundlephobia/min/postcode.svg?style=flat)](https://bundlephobia.com/result?p=postcode)
1111
[![Downloads](https://img.shields.io/npm/dm/postcode.svg)](https://www.npmjs.com/package/postcode)
@@ -116,49 +116,9 @@ Postcode.toSector("Sw1A 2aa"); // => "SW1A 2"
116116
Postcode.toUnit("Sw1A 2aa"); // => "AA"
117117
```
118118

119-
### Older API
119+
### Legacy API
120120

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)
162122

163123
## Definitions
164124

0 commit comments

Comments
 (0)