mirror of https://github.com/Turfjs/turf.git synced 2026-01-25 16:07:00 +00:00

Update generate-readmes script to typescript, update content wording, and regenerate all readmes (#2528 )

* Fix generate-docs to work with tsx (add extension, fix a few TS errors). monorepolint rule changed to reflect ts file extension. Add node to eslint env config so editors can find definitions of node variables (such as __dirname) used in scripts.

* Change project root docs target to use tsx and generate-docs.ts. Tighten up gnerates-docs.ts folder globbing - was inadvertently matching when my working parent directory was named something like ~/code/turf-docs-test/... interpreting docs-test as a package name. Reworded readme postfix content to be clearer on the different ways of installing. Updated a few links from http to https.

* Result of running yarn docs from the project root with the previously committed changes.

* Applying recently merged changes (from PR #2523) to this new module.

2023-11-03 20:22:53 +11:00

1.6 KiB

Raw Permalink Blame History

@turf/explode

explode

Takes a feature or set of features and returns all positions as points.

Parameters

geojson GeoJSON input features

Examples

var polygon = turf.polygon([[[-81, 41], [-88, 36], [-84, 31], [-80, 33], [-77, 39], [-81, 41]]]);

var explode = turf.explode(polygon);

//addToMap
var addToMap = [polygon, explode]

Throws Error if it encounters an unknown geometry type

Returns FeatureCollection<point> points representing the exploded input features

This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

Installation

Install this single module individually:

$ npm install @turf/explode

Or install the all-encompassing @turf/turf module that includes all modules as functions:

$ npm install @turf/turf

1.6 KiB Raw Permalink Blame History