An easy to use postcodes.io wrapper for NodeJS.
Install the package with npm:
$ npm i node-postcodes.ioconstpostcodes=require('node-postcodes.io')http://postcodes.io/docs#Postcode-Lookup
// singleletresult=awaitpostcodes.lookup('PO123AA')// batchletresult=awaitpostcodes.lookup(['PO123AA','PO123AB'])// batch (with filter)letresult=awaitpostcodes.lookup(['PO123AA','PO123AB'],{filter: 'postcode,longitude,latitude'})http://postcodes.io/docs#Geocode-Postcode
//letresult=awaitpostcodes.geo(51.7923246977375,0.629834723775309)// with optional paramsletresult=awaitpostcodes.geo(51.7923246977375,0.629834723775309,{limit: 10,radius: 10,wideSearch: false})//letresult=awaitpostcodes.geo([{"longitude": 0.629834723775309,"latitude": 51.7923246977375,"radius": 1000,"limit": 5},{"longitude": -2.49690382054704,"latitude": 53.5351312861402,"radius": 1000,"limit": 5}])// with optional paramsletresult=awaitpostcodes.geo([{"longitude": 0.629834723775309,"latitude": 51.7923246977375,"radius": 1000,"limit": 5},{"longitude": -2.49690382054704,"latitude": 53.5351312861402,"radius": 1000,"limit": 5}],{filter: 'postcode,longitude,latitude',wideSearch: false})http://postcodes.io/docs#Geocode-Postcode
letresult=awaitpostcodes.random()http://postcodes.io/docs#Postcode-Validation
letresult=awaitpostcodes.validate('PO123AA')http://postcodes.io/docs#Nearest-Postcode
letresult=awaitpostcodes.nearest('PO123AA')// with optional paramsletresult=awaitpostcodes.nearest('PO123AA',{radius: 1000,limit: 5})http://postcodes.io/docs#Postcode-Autocomplete
letresult=awaitpostcodes.autocomplete('PO123AA')// with optional paramsletresult=awaitpostcodes.autocomplete('PO123AA',{limit: 5})http://postcodes.io/docs#Postcode-Query
letresult=awaitpostcodes.query('PO123AA')// with optional paramsletresult=awaitpostcodes.query('PO123AA',{limit: 5})http://postcodes.io/docs#Terminated
letresult=awaitpostcodes.terminated('PO123AA')http://postcodes.io/docs#Show-Outcode
// lookupletresult=awaitpostcodes.outcodes('PO33')// nearestletresult=awaitpostcodes.outcodes('PO3',{limit: 10,radius: 10})// nearest (lat, lng)letresult=awaitpostcodes.outcodes(51.7923246977375,0.629834723775309)// with optional paramsletresult=awaitpostcodes.outcodes(51.7923246977375,0.629834723775309,{limit: 10,radius: 10})http://postcodes.io/docs#Place-Lookup
// lookupletresult=awaitpostcodes.places('osgb4000000074553605')// queryletresult=awaitpostcodes.places('Ryde',{limit: 10})// randomletresult=awaitpostcodes.places()Can see test results @ https://travis-ci.org/lcherone/node-postcodes.io, if you want to run them locally, your need install mocha, then run:
$ npm testThe MIT License (MIT). Please see License File for more information.
