# @turf/shortest-path

> Returns the shortest path from start to end without colliding with any Feature in obstacles.

Latest version **7.4.0** (published 2026-08-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @turf/shortest-path
pnpm add @turf/shortest-path
yarn add @turf/shortest-path
bun add @turf/shortest-path
```

## Health

**Score 80/100 (A)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score; popular repo.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 7.4.0 |
| Published | 2026-08-03 |
| First published | 2017-10-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 11 |
| Unpacked size | 94.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 10491 |
| Author | Turf Authors |
| Maintainers | rowanwins, tmcw, morganherlocker, tcql, mdfedderly, twelch, jamesmilneruk, morgan.herlocker |
| Keywords | turf, shortest-path, path |

## Links

- npm: https://www.npmjs.com/package/@turf/shortest-path
- Repository: https://github.com/Turfjs/turf
- Issues: https://github.com/Turfjs/turf/issues
- Funding: https://opencollective.com/turf
- npm.io page: https://npm.io/package/@turf/shortest-path

## Dependencies (11)

- [tslib](https://npm.io/package/tslib.md) ^2.8.1
- [@turf/bbox](https://npm.io/package/@turf/bbox.md) 7.4.0
- [@turf/meta](https://npm.io/package/@turf/meta.md) 7.4.0
- [@turf/helpers](https://npm.io/package/@turf/helpers.md) 7.4.0
- [@turf/distance](https://npm.io/package/@turf/distance.md) 7.4.0
- [@types/geojson](https://npm.io/package/@types/geojson.md) ^7946.0.10
- [@turf/invariant](https://npm.io/package/@turf/invariant.md) 7.4.0
- [@turf/bbox-polygon](https://npm.io/package/@turf/bbox-polygon.md) 7.4.0
- [@turf/clean-coords](https://npm.io/package/@turf/clean-coords.md) 7.4.0
- [@turf/transform-scale](https://npm.io/package/@turf/transform-scale.md) 7.4.0
- [@turf/boolean-point-in-polygon](https://npm.io/package/@turf/boolean-point-in-polygon.md) 7.4.0

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 7.4.0 (latest) — 2026-08-03
- 7.1.0-alpha.70 (prerelease) — 2024-08-09
- 7.3.5 — 2026-04-19
- 7.3.4 — 2026-02-08
- 7.3.3 — 2026-01-28
- 7.3.2 — 2026-01-14
- 7.3.1 — 2025-11-27
- 7.3.0 — 2025-11-17
- 7.2.0 — 2024-12-29
- 7.1.0 — 2024-08-09
- 7.1.0-alpha.7 — 2024-06-25
- 7.0.0 — 2024-06-07
- 7.0.0-alpha.116 — 2024-05-07
- 7.0.0-alpha.115 — 2024-04-23
- 7.0.0-alpha.114 — 2024-03-11
- … 18 more at https://npm.io/package/@turf/shortest-path/versions

## README

# @turf/shortest-path

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

## shortestPath

Returns the shortest [path][1] from [start][2] to [end][2] without colliding with
any [Feature][3] in obstacles [FeatureCollection][4]<[Polygon][5]>

### Parameters

*   `start` **[Coord][6]** point
*   `end` **[Coord][6]** point
*   `options` **[Object][7]** optional parameters (optional, default `{}`)

    *   `options.obstacles` **([Polygon][5] | [Feature][3]<[Polygon][5]> | [FeatureCollection][4]<[Polygon][5]>)?** areas which path cannot travel
    *   `options.units` **Units** unit in which resolution & minimum distance will be expressed in; Supports all valid Turf [Units][8]. (optional, default `'kilometers'`)
    *   `options.resolution` **[number][9]** distance between matrix points on which the path will be calculated (optional, default `100`)

### Examples

```javascript
var start = [-5, -6];
var end = [9, -6];
var options = {
  obstacles: turf.polygon([[[0, -7], [5, -7], [5, -3], [0, -3], [0, -7]]]).geometry
};

var path = turf.shortestPath(start, end, options);

//addToMap
var addToMap = [start, end, options.obstacles, path];
```

Returns **[Feature][3]<[LineString][1]>** shortest path between start and end

[1]: https://tools.ietf.org/html/rfc7946#section-3.1.4

[2]: https://tools.ietf.org/html/rfc7946#section-3.1.2

[3]: https://tools.ietf.org/html/rfc7946#section-3.2

[4]: https://tools.ietf.org/html/rfc7946#section-3.3

[5]: https://tools.ietf.org/html/rfc7946#section-3.1.6

[6]: https://tools.ietf.org/html/rfc7946#section-3.1.1

[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[8]: https://turfjs.org/docs/api/types/Units

[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->

---

This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.

### Installation

Install this single module individually:

```sh
$ npm install @turf/shortest-path
```

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

```sh
$ npm install @turf/turf
```

---
_Source: https://npm.io/package/@turf/shortest-path · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._