https://github.com/ehmpathy/domain-glossary-postcode
a glossary of intuitive, universally unambiguous postcode definitions and procedures
https://github.com/ehmpathy/domain-glossary-postcode
Last synced: 4 months ago
JSON representation
a glossary of intuitive, universally unambiguous postcode definitions and procedures
- Host: GitHub
- URL: https://github.com/ehmpathy/domain-glossary-postcode
- Owner: ehmpathy
- License: mit
- Created: 2024-12-12T11:57:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-23T21:45:19.000Z (7 months ago)
- Last Synced: 2025-08-09T04:48:32.992Z (5 months ago)
- Language: TypeScript
- Size: 719 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# domain-glossary-postcode
A glossary of intuitive, universally unambiguous postcode definitions and procedures.
# purpose
enable static-type checks for postcodes
- `Postcode` = `AsOfGlossary`
- `isPostcode`
declare useful procedures to operate on postcodes
- e.g., `getCentroidOfPostcode`
# install
```sh
npm install domain-glossary-postcode
```
# use
## Postcode
### declare that a given variable is a postcode
```ts
const postcode: Postcode;
```
### assure that a given string is a postcode
```ts
const postcode: Postcode = isPostcode.assure('33127');
```
### get the geocode of a postcode
```ts
const centroid: Geocode = getCentroidOfPostcode('33127')
```