New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More

openlr_decoder

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

openlr_decoder

A general purpose road network OpenLR decoding solution


Version published
Weekly downloads
2
increased by100%
Maintainers
1
Weekly downloads
 
Created

openlr_decoder

Coverage Status CodeQL Analysis Build and test

A general purpose OpenLR decoding solution for any suitable road network.

Introduction

OpenLR is a dynamic location reference standard to enable systems to exchange location information in a map-agnostic manner. For further info see OpenLR association. This module provides a simple and performant solution to decode an openLR reference.

Dependencies

This module requires a mongodb database instance or an Azure Cosmos instance with support for mongodb api enabled.

Support for more backends will be added in future releases

Installation

Install the module with npm:

npm install openlr_decoder

Import the module

For commonjs:

const {decodeOpenLR, initStorage} = require("openlr_decoder");

For typescript:

import {decodeOpenLR, initStorage} from "openlr_decoder";

Example Usage

Initialise a storage connection with the chosen storage backend, the database url, and database name.

Decode an OpenLR string providing the string and any options.

async main(){

    // Backend storage connection options
    const options = {
        storageBackend: "mongodb",
        url: "127.0.0.1:27017",
        dbName: "streetMap"
    }

    await initStorage(options);

    const result = await decodeOpenLr("C/+/+yY40CuxDAA6/WgrHw==", {targetBearing: 25, searchRadius: 100});

}

Storage Schema

The module expects data in the below described schemas for the chosen storage medium.

Mongo Collection Design

The module expects the mongodb database to have a collection named "nodes" which contains only node documents. Each node should contain two arrays named startLinks and endLinks. The startLinks array contains links which start from this node and the endLinks array contains links which end at this node. A JSON schema file is provided here.

A complete ready to use set of OS open roads data in this format, extracted from a MongoDB collection, is provided for download here [TODO].

A fully worked example of getting an OpenLR service up and running is provided here [TODO].

FAQs

Package last updated on 21 Sep 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts