gridref-js

Parse Ordnance Survey Great Britain alpha numeric grid references into a bounding box.

Installation

npm i @astuntech/gridref-js

Usage

import { parse, InvalidGridRef } from "@astuntech/gridref-js";

let gridRef = "SU387148";
let bbox = null;
try {
  bbox = parse(gridRef);
  console.log(bbox);
} catch (e) {
  if (e instanceof InvalidGridRef) {
    console.error(e.message);
  } else {
    throw e;
  }
}

API

parse(gridref) ⇒ Array.<Number>

Converts OSGB grid reference ('SU387148') to bounding box in British National Grid ([438700, 114800, 438800, 114900])

Kind: global function
Returns: Array.<Number> - Bounding box of grid reference in metres

| Param | Type | Description | | --- | --- | --- | | gridref | String | Standard format OSGB grid reference (e.g. SU387148) |

Credit

Derived from https://github.com/peterhaldbaek/mt-osgridref

License

MIT