Skip to content

A simple function that gives you all the data for a certain classification code bound to a address served by OS' AddressBase database.

Notifications You must be signed in to change notification settings

danielkaczmarczyk/os-helper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

OS Helper

OS helper decode is a function that expands the data regarding classification codes for properties within UK that are a part of AddressBase database distributed by OS' Places API. Find more at OS Places API docs

To use it, simply import it and call decode, passing it your classification code. Example:

npm install os-helper

import osHelper from 'os-helper';

console.log(osHelper.decode('ZW99LG'))

console output:
>>> 
{ Concatenated: 'ZW99LG',
  Class_Desc: 'Lych Gate',
  Primary_Code: 'Z',
  Secondary_Code: 'W',
  Tertiary_Code: '99',
  Quaternary_Code: 'LG',
  Primary_Desc: 'Object of Interest',
  Secondary_Desc: 'Place Of Worship',
  Tertiary_Desc: '',
  Quaternary_Desc: 'Lych Gate'
}

About

A simple function that gives you all the data for a certain classification code bound to a address served by OS' AddressBase database.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published