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
Что это такое?Turf — это модульный геопространственный движок для JavaScript и TypeScript, библиотека для пространственного анализа, работающая с данными GeoJSON.
Это библиотека, которую я подключаю к своему коду, или приложение, которое я запускаю?Это библиотека без собственного интерфейса: подключите её к сайту как клиентский модуль или запускайте на сервере через Node.js.
Как мне начать с ней работать?Установите пакет @turf/turf из npm, затем следуйте руководству по началу работы и посмотрите документацию по API с примерами на turfjs.org.
На каких средах выполнения JavaScript я могу её запустить?На любой достаточно современной среде JS — Node здесь на первом месте (используйте релиз Active или Maintenance LTS). Deno и Bun официально не поддерживаются.
Есть ли подводные камни при сборке Turf для браузера?Да — при сборке нужно транслировать и полифиллить Turf вместе со всеми его транзитивными зависимостями под целевые браузеры, иначе в старых браузерах всё может сломаться.
Она работает и в браузере, или только под Node?И там, и там. Пакет @turf/turf содержит готовый браузерный бандл — все модули, объединённые, транслированные и минифицированные в один JavaScript-файл.
Какие пространственные инструменты в неё входят?Классические пространственные операции, вспомогательные функции для создания данных GeoJSON, а также инструменты классификации и статистики.
Turf называют модульным — что это значит на практике?Turf разрабатывается как множество небольших модулей — по одному на функцию; пакет @turf/turf объединяет их, а его браузерная сборка компилирует все модули в один минифицированный файл.
Turf рисует карты или только считает?Он только вычисляет: пространственные операции, создание GeoJSON и статистику. В README не описано никакой отрисовки или интерфейса, так что визуализация — задача той картографической утилиты, которая покажет результаты.
Проект до сих пор активно поддерживается?Да — он развивается с 2013 года, набрал больше 10 000 звёзд на GitHub и использует автоматизированные CI и процессы релизов.
Creator
Turfjs
Size
57.6 MB
Stars
10.5K
Age
13y
Commits · 90 Days