Skip to content

Commit a19c68f

Browse files
committed
Shorten readme. Link guide for postcode glossary
1 parent 77a87f0 commit a19c68f

File tree

1 file changed

+4
-39
lines changed

1 file changed

+4
-39
lines changed

README.md

Lines changed: 4 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -127,48 +127,13 @@ The legacy object based API is documented in [LEGACY.md](LEGACY.md)
127127

128128
## Definitions
129129

130-
### Outcode
130+
[See the postcode format guide](https://ideal-postcodes.co.uk/guides/uk-postcode-format/) for a glossary of postcode component terms.
131131

132-
The outward code is the part of the postcode before the single space in the middle. It is between two and four characters long. A few outward codes are non-geographic, not divulging where mail is to be sent. Examples of outward codes include "L1", "W1A", "RH1", "RH10" or "SE1P".
132+
## Notes
133133

134-
### Incode
134+
Postcodes cannot be validated just with a regular expression (however complex). True postcode validation requires having a full list of postcodes to check against. Relying on a regex will produce false postives/negatives.
135135

136-
The inward part is the part of the postcode after the single space in the middle. It is three characters long. The inward code assists in the delivery of post within a postal district. Examples of inward codes include "0NY", "7GZ", "7HF", or "8JQ".
137-
138-
### Area
139-
140-
The postcode area is part of the outward code. The postcode area is between one and two characters long and is all letters. Examples of postcode areas include "L" for Liverpool, "RH" for Redhill and "EH" Edinburgh. A postal area may cover a wide area, for example "RH" covers north Sussex, (which has little to do with Redhill historically apart from the railway links), and "BT" (Belfast) covers the whole of Northern Ireland.
141-
142-
### District
143-
144-
The district code is part of the outward code. It is between two and four characters long. It does not include the trailing letter found in some outcodes. Examples of district codes include "L1", "W1", "RH1", "RH10" or "SE1".
145-
146-
### Sub-District
147-
148-
The sub-district code is part of the outward code. It is often not present, only existing in particularly high density London districts. It is between three and four characters long. It does include the trailing letter omitted from the district. Examples of sub-district codes include "W1A", "EC1A", "NW1W", "E1W" or "SE1P".
149-
150-
Note: for outcodes not ending with a letter, `subDistrict` will return `null`. For example:
151-
152-
```js
153-
new Postcode("SW1A 1AA").subDistrict() // => SW1A
154-
new Postcode("E1W 1LD").subDistrict() // => E1W
155-
new Postcode("PO16 7GZ").subDistrict() // => null
156-
new Postcode("B5 5NY").subDistrict() // => null
157-
```
158-
159-
### Sector
160-
161-
The postcode sector is made up of the postcode district, the single space, and the first character of the inward code. It is between four and six characters long (including the single space). Examples of postcode sectors include "SW1W 0", "PO16 7", "GU16 7", or "L1 8", "CV1 4".
162-
163-
### Unit
164-
165-
The postcode unit is two characters added to the end of the postcode sector. Each postcode unit generally represents a street, part of a street, a single address, a group of properties, a single property, a sub-section of the property, an individual organisation or (for instance Driver and Vehicle Licensing Agency) a subsection of the organisation. The level of discrimination is often based on the amount of mail received by the premises or business. Examples of postcode units include "NY" (from "SW1W 0NY"), "GZ" (from "PO16 7GZ"), "HF" (from "GU16 7HF"), or "JQ" (from "L1 8JQ").
166-
167-
## Note on Postcode Validation
168-
169-
Postcodes cannot be validated just with a regular expression. Proper postcode validation requires having a full list of postcodes to check against. Relying on a regex will produce false postives/negatives.
170-
171-
[See our postcode validation guide](https://ideal-postcodes.co.uk/guides/postcode-validation) for an overview of the approaches and tradeoffs associated with postcode validation.
136+
[See the postcode validation guide](https://ideal-postcodes.co.uk/guides/postcode-validation) for an overview of the approaches and tradeoffs associated with postcode validation.
172137

173138
## Testing
174139

0 commit comments

Comments
 (0)