Skip to content

Latest commit

 

History

History
113 lines (77 loc) · 3.09 KB

README.md

File metadata and controls

113 lines (77 loc) · 3.09 KB

@terraformer/wkt

npm travis standard

Tools to convert WKT geometries to GeoJSON geometries and vice versa.

Install

npm install @terraformer/wkt

API Reference

Terraformer

Terraformer.wktToGeoJSON(WKT) ⇒ object

Converts a WKT geometry into a GeoJSON geometry.

Kind: static method of Terraformer
Returns: object - GeoJSON.

import { wktToGeoJSON } from "@terraformer/wkt"

wktToGeoJSON("POINT (-122.6764 45.5165)");

>> { "type": "Point", "coordinates": [ -122.6764, 45.5165 ] }
Param Type Description
WKT string The input WKT geometry.

Terraformer.geojsonToWKT(GeoJSON) ⇒ string

Converts a GeoJSON geometry or GeometryCollection into a WKT string.

Kind: static method of Terraformer
Returns: string - WKT.

import { geojsonToWKT } from "@terraformer/wkt"

const geojsonPoint = {
  "type": "Point",
  "coordinates": [-122.6764, 45.5165]
}

geojsonToWKT(geojsonPoint)

>> "POINT (-122.6764 45.5165)"
Param Type Description
GeoJSON object The input GeoJSON geometry or GeometryCollection.

Usage

Browser (from CDN)

This package is distributed as a UMD module and can also be used in AMD based systems or as a global under the Terraformer namespace.

<script src="https://unpkg.com/@terraformer/wkt"></script>
Terraformer.wktToGeoJSON("POINT (-122.6764 45.5165)");

Node.js

const Terraformer = require('@terraformer/wkt');

Terraformer.geojsonToWKT(/* ... */);
Terraformer.wktToGeoJSON(/* ... */);

ES module in the browser

<script type='module'>
  import { wktToGeoJSON } from 'https://unpkg.com/@terraformer/wkt?module';

  // look ma, no build step!
  wktToGeoJSON(/* ... */);
</script>