Skip to content

Repository files navigation

turf

GitHub Actions Status Version Badge Gitter chat Backers on Open Collective Sponsors on Open Collective Coverage Status

A modular geospatial engine written in JavaScript

Turf is a JavaScript library for spatial analysis. It includes traditional spatial operations, helper functions for creating GeoJSON data, and data classification and statistics tools. Turf can be added to your website as a client-side module, or you can run Turf server-side with Node.js (see below).

Getting Started

Read our getting started guide to begin working with Turf.

Or explore the Turf API and examples at turfjs.org.

Runtime support

Turf is currently published to work with any reasonably modern Javascript runtime.

Node is a first class citizen, and we recommend using an Active or Maintenance LTS release.

Other runtimes, such as Deno or Bun, are not officially supported. We would be very interested to hear your experiences though.

When bundling Turf for the browser, ensure your build setup transpiles and polyfills Turf along with all of its transitive dependencies to match your target browsers.

Browser support

@turf/turf includes a browser bundle that combines, transpiles, and minifies all Turf modules into a single JavaScript file. We periodically update our minimum browser targets using Browserslist's default preset.

Contributors

This project exists thanks to all the people who contribute. If you are interested in helping, check out the Contributing Guide.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

About

A modular geospatial engine written in JavaScript and TypeScript

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

10.4k stars

Watchers

175 watching

Forks

Releases

Used by

Contributors

Languages