mirror of
https://github.com/Turfjs/turf.git
synced 2026-01-25 16:07:00 +00:00
6cb60c951d
* 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.
1.7 KiB
Executable File
1.7 KiB
Executable File
@turf/boolean-clockwise
booleanClockwise
Takes a ring and return true or false whether or not the ring is clockwise or counter-clockwise.
Parameters
line(Feature<LineString> | LineString | Array<Array<number>>) to be evaluated
Examples
var clockwiseRing = turf.lineString([[0,0],[1,1],[1,0],[0,0]]);
var counterClockwiseRing = turf.lineString([[0,0],[1,0],[1,1],[0,0]]);
turf.booleanClockwise(clockwiseRing)
//=true
turf.booleanClockwise(counterClockwiseRing)
//=false
Returns boolean true/false
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/boolean-clockwise
Or install the all-encompassing @turf/turf module that includes all modules as functions:
$ npm install @turf/turf