turf README

The project's README from github.com/Turfjs/turf. As one markdown file: README.md.

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]

turf (Turfjs/turf)

Searching Database…

10.5K ·GitHub
What is this?Turf is a modular geospatial engine for JavaScript and TypeScript — a library for spatial analysis that works with GeoJSON data.
Is it a library I add to my own code, or an app I run?It's a library with no UI of its own: add it to a website as a client-side module or run it server-side with Node.js.
How do I get started with it?Install the @turf/turf package from npm, then follow the getting started guide and browse the API docs with examples at turfjs.org.
Which JavaScript runtimes can I run it on?Any reasonably modern JS runtime — Node is the first-class citizen (use an Active or Maintenance LTS release). Deno and Bun are not officially supported.
Any gotchas when bundling Turf for the browser?Yes — your build must transpile and polyfill Turf together with all of its transitive dependencies to match your target browsers, or older browsers may fail.
Does it work in the browser too, or is it Node-only?Both. The @turf/turf package ships a prebuilt browser bundle — all modules combined, transpiled, and minified into one JavaScript file.
What kinds of spatial tools does it include?Traditional spatial operations, helper functions for creating GeoJSON data, and data classification and statistics tools.
Turf is called modular — what does that mean in practice?Turf is developed as many small per-function modules; the @turf/turf package combines them, and its browser build compiles every module into one minified file.
Does Turf draw maps, or only crunch the numbers?It computes: spatial operations, GeoJSON creation, and statistics. The README describes no rendering or UI, so visualization is up to whatever map tool displays your results.
Is the project still actively maintained?Yes — it has been developed since 2013, holds over 10,000 GitHub stars, and uses automated CI and release workflows.
Creator
Turfjs
Size
57.6 MB
Stars
10.5K
Age
13y
Commits · 90 Days