Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rowanwins/po-box
This simple tool for checking for the presence of, and extracting PO Box details from an address string.
https://github.com/rowanwins/po-box
Last synced: 28 days ago
JSON representation
This simple tool for checking for the presence of, and extracting PO Box details from an address string.
- Host: GitHub
- URL: https://github.com/rowanwins/po-box
- Owner: rowanwins
- License: mit
- Created: 2016-09-28T09:21:52.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-05-08T06:43:27.000Z (over 4 years ago)
- Last Synced: 2024-05-27T19:11:09.310Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 4.88 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# PO-BOX
This simple tool for checking for the presence of, and extracting PO BOX details from an address string.
## Install
```
npm install po-box
```
## Usage
pobox provides 2 methods
`extractPoBox(addressString)` returns an object containing various information
````
var pobox = require('po-box');
var addressString = "PO BOX 123, Main St, City, Country"
pobox.extractPoBox(addressString);
// returns {
// containsPoBox: true,
// fullString: 'PO BOX 123',
// poBoxNumber: '123',
// poBoxDesc: 'PO BOX'
// }
````
`containsPoBox(addressString)` simply returns true or false
````
var pobox = require('po-box');
var addressString = "PO BOX 123, Main St, City, Country"
pobox.containsPoBox(addressString);
// returns true
````
## Matching Information
This module uses a regular expression to determine the presence of PO Box information. It looks for a range of common variations including upper case vs lower case, use of acroynms vs full spelling, at the start of the string vs in the middle etc
````
// Will return a match
- p.o. BOX 234 Main St, City, Country
- P.O. BOX 234 Main St, City, Country
- Main St, P.O. BOX 234, City, Country
- post office BOX 234 Main St, City, Country
- PO BOX 234 Main St, City, Country
- po box 234 Main St, City, Country
- po Box 234, 453 Main St, City, Country
- Postal Office BOX 234, Main St, City, Country
- POST BOX 234, Main St, City, Country
- POST BOX NO 234, Main St, City, Country
- POSTAL BOX 234, Main St, City, Country
- PO 234, 345 Main St, City, Country
// Won't return a match
- 345 Box St, Main St, City, Country
- 345 Po St, Main St, City, Country
- POSTAL NOTHING 234 Main St, City, Country
- p.o. BOX ABC, Main St, City, Country
````