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

2.1 KiB

Raw Permalink Blame History

@turf/angle

angle

Finds the angle formed by two adjacent segments defined by 3 points. The result will be the (positive clockwise) angle with origin on the startPoint-midPoint segment, or its explementary angle if required.

Parameters

startPoint Coord Start Point Coordinates
midPoint Coord Mid Point Coordinates
endPoint Coord End Point Coordinates
options Object Optional parameters (optional, default {})
- options.explementary boolean Returns the explementary angle instead (360 - angle) (optional, default false)
- options.mercator boolean if calculations should be performed over Mercator or WGS84 projection (optional, default false)

Examples

turf.angle([5, 5], [5, 6], [3, 4]);
//=45

Returns number Angle between the provided points, or its explementary.

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/angle

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

$ npm install @turf/turf

2.1 KiB Raw Permalink Blame History