olc-plus-codes v1.0.1

Feature

Create Plus Codes (Open Location Code) from Location and reverse Plus Codes to location. Implementation for Javascript/Typescript.

Installation

npm install olc-plus-codes

Usage

Import

Typescript:

import { PlusCodes } from 'olc-plus-codes'
var plusCodes = new PlusCodes();

Javascript:

var PlusCodes = require('olc-plus-codes').PlusCodes
var plusCodes = new PlusCodes();

Methods:

  /** Transform a location to code */
  encode(latitude: number, longitude: number, codeLength: number = 10): string;
  /** Reverse a code to location */
  decode(code: string): CodeArea;
  /** Transform a full-code to short-code */
  shorten(code: string, latitude: number, longitude: number): string;
  /** Reverse a short-code to full-code with any nearnest location which you known */
  recoverNearest(shortCode: string, referenceLatitude: number, referenceLongitude: number): string;
  /** Check a string is a code */
  isValid(code: string): boolean;
  /** Check a code is a full-code */
  isFull(code: string): boolean;
  /** Check a code is a short-code */
  isShort(code: string): boolean;
  /** Get area info from bottom-left location and top-right location */
  CodeArea(latitudeLo: number, longitudeLo: number, latitudeHi: number, longitudeHi: number, codeLength: number): CodeArea;
  /** Testing */
  Test(latitude: number, longitude: number, codeLength: number): void

Testing:

import { PlusCodes } from 'olc-plus-codes'
var plusCodes = new PlusCodes();
let lat = 40.68925759276426
let lon = -74.04450089452236
plusCodes.Test(lat,lon,12)