Package Exports

wkt-parser-helper

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (wkt-parser-helper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

wkt-parser-helper

Convert and parse between Well-Known-Text (WKT) and GeoJSON

Installation

Using npm npm i wkt-parser-helper

Using yarn yarn add wkt-parser-helper

Usage

In CommonJS env

const { parseFromWK } = require('wkt-parser-helper');

const geojson = parseFromWK(
  'POLYGON ((-3.706512451171875 40.420074462890625, -3.70513916015625 40.420074462890625, -3.70513916015625 40.42144775390625, -3.706512451171875 40.42144775390625, -3.706512451171875 40.420074462890625))'
);

// geojson is a Polygon Geometry

Using imports

import { convertToWK } from 'wkt-parser-helper';

const myFeature: Feature = {
  type: 'Feature',
  properties: {},
  geometry: {
    type: 'Polygon',
    coordinates: [
      [
        [-3.706512451171875, 40.420074462890625],
        [-3.70513916015625, 40.420074462890625],
        [-3.70513916015625, 40.42144775390625],
        [-3.706512451171875, 40.42144775390625],
        [-3.706512451171875, 40.420074462890625],
      ],
    ],
  },
};

const myFeatureAsWKT = convertToWK(myFeature);

// myFeatureAsWKT is 'POLYGON ((-3.706512451171875 40.420074462890625, -3.70513916015625 40.420074462890625, -3.70513916015625 40.42144775390625, -3.706512451171875 40.42144775390625, -3.706512451171875 40.420074462890625))'

Breaking changes

From v4.0.0 onwards, support for converting GeoJSON to WKB is dropped.

Functions

convertFeatureCollection

▸ convertFeatureCollection(featureCollection: FeatureCollection): string

Converts a GeoJSON FeatureCollection to WKT GeometryCollection

export

Parameters:

Name	Type	Description
`featureCollection`	FeatureCollection	The FeatureCollection to convert to WKT

Returns: string

The GeoJSON converted to well known representation

Defined in: index.ts:34

convertFeatureToWK

▸ convertFeatureToWK(geojson: Feature): string

Converts GeoJSON Feature to WKT

export

Parameters:

Name	Type	Description
`geojson`	Feature	Feature object to convert

Returns: string

The GeoJSON converted to well known text representation

Defined in: index.ts:24

convertGeometryToWK

▸ convertGeometryToWK(geojson: Geometry): string

Converts GeoJSON Geometry to WKT

export

Parameters:

Name	Type	Description
`geojson`	Geometry	Geometry object to convert

Returns: string

The GeoJSON converted to well known text representation

Defined in: index.ts:13

convertToWK

▸ convertToWK(geojson: GeoJSON): string

Shorthand to convert GeoJSON Features, Geometries or FeatureCollections to WKT or WKB

export

Parameters:

Name	Type	Description
`geojson`	GeoJSON	The GeoJSON to convert

Returns: string

The GeoJSON as WKT

Defined in: index.ts:51

parseFromWK

▸ parseFromWK(item: string, asFeature?: boolean, properties?: GeoJsonProperties): Feature | Geometry

Parse a WKT or WKB into a GeoJSON Feature or Geometry

export

Parameters:

Name	Type	Default value	Description
`item`	string	-	The WKT to convert to GeoJSON
`asFeature`	boolean	false	-
`properties`	GeoJsonProperties	-	-

Returns: Feature | Geometry

The WKT as GeoJSON

Defined in: index.ts:71