gzd-utils/README.md

Utilities for working with MGRS GZD and GeoJSON

# GZD Utils for Nodejs

[![travis](https://img.shields.io/travis/gustavlarson/gzd-utils)](https://travis-ci.org/github/gustavlarson/gzd-utils)
[![codecov](https://img.shields.io/codecov/c/github/gustavlarson/gzd-utils?token=MGBMEMQLGE)](https://codecov.io/gh/gustavlarson/gzd-utils)
[![npm](https://img.shields.io/npm/v/gzd-utils)](https://www.npmjs.com/package/gzd-utils)
[![size](https://img.shields.io/bundlephobia/minzip/gzd-utils)](https://bundlephobia.com/result?p=gzd-utils)
[![license](https://img.shields.io/github/license/gustavlarson/gzd-utils)](https://choosealicense.com/licenses/isc/)

Utilities for calculating [MGRS GZDs](https://en.wikipedia.org/wiki/Military_Grid_Reference_System) in Nodejs.

## Installation

    $ npm install gzd-utils

## Usage

```typescript
import { Polygon } from 'geojson';
import { getAllGZD, getGZD } from 'gzd-utils';

// Get all GZDs
const gzdZones = getAllGZD();
gzdZones.features.forEach((zone) => {
  console.log(`Zone: ${zone.properties['name']}`);
  const polygon = zone.geometry as Polygon;
  console.log(`Coordinates: ${polygon.coordinates}`);
};

// Get a specific GZD
let zone = getGZD('33V');
console.log(`Zone: ${zone.properties['name']}`);
let polygon = zone.geometry as Polygon;
console.log(`Coordinates: ${polygon.coordinates}`);

// Alternate way of getting a specific GZD
zone = getGZD(33, 'V');
console.log(`Zone: ${zone.properties['name']}`);
polygon = zone.geometry as Polygon;
console.log(`Coordinates: ${polygon.coordinates}`);
```