coordinate-formats

A library for parsing and formatting coordinates.

Usage no npm install needed!

<script type="module">
  import coordinateFormats from 'https://cdn.skypack.dev/coordinate-formats';
</script>

README

Coordinate Formats

A library for parsing and formatting coordinates.

:globe_with_meridians: Website | :book: API Documentation | :floppy_disk: Repository

coverage

Getting started

Install the npm package:

npm i coordinate-formats

Import the functions you need into your project and start using them (for the full reference, check out the API Documentation):

import { parsePossibleCoordinates } from 'coordinate-formats';

const coordinatesString = '23 34, 12 32';

// parse coordinates
const possibleCoordinates = parsePossibleCoordinates(coordinatesString);

// format coordinates
const coordinates = possibleCoordinates[0];
const coordinatesFormatted = coordinates.toString();

Development

In order to start with the development, clone the repository and run:

Install npm dependencies:

npm install

Run the development environment:

npm start

This will start:

  • The TypeScript compiler in watch mode
  • The unit testing suite in watch mode
  • The development server for the website (http://localhost:3000)
  • The TypeDoc API documentation generation in watch mode (http://localhost:3000/api)