# turf-along

> # along

Latest version **3.0.12** (published 2016-07-05) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install turf-along
pnpm add turf-along
yarn add turf-along
bun add turf-along
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.12 |
| Published | 2016-07-05 |
| First published | 2015-01-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | morganherlocker |
| Maintainers | morganherlocker, mourner, jvrousseau, jseppi, cspanring, cwmma, tmcw |
| Keywords | along, line, linestring, turf, distance |

## Links

- npm: https://www.npmjs.com/package/turf-along
- Repository: https://github.com/Turfjs/turf-along
- Issues: https://github.com/Turfjs/turf-along/issues
- npm.io page: https://npm.io/package/turf-along

## Dependencies (4)

- [turf-bearing](https://npm.io/package/turf-bearing.md) ^3.0.12
- [turf-helpers](https://npm.io/package/turf-helpers.md) ^3.0.12
- [turf-distance](https://npm.io/package/turf-distance.md) ^3.0.12
- [turf-destination](https://npm.io/package/turf-destination.md) ^3.0.12

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 3.0.12 (latest) — 2016-07-05
- 3.0.7-canary.ae89c8b3 (canary) — 2016-06-14
- 3.0.10 — 2016-06-15
- 3.0.7 — 2016-06-13
- 3.0.6 — 2016-06-03
- 3.0.5-canary.4f73aa1a — 2016-06-03
- 3.0.5 — 2016-05-17
- 3.0.4 — 2016-05-17
- 3.0.1 — 2016-05-16
- 3.0.0-canary.7879bf6c — 2016-05-16
- 3.0.0-canary.2f5f7167 — 2016-05-16
- 1.0.2 — 2015-02-06
- 1.0.1 — 2015-01-29
- 1.0.0 — 2015-01-20

## README

# turf-along

# along

Takes a [line](LineString) and returns a [point](Point) at a specified distance along the line.

**Parameters**

-   `line` **Feature<LineString>** input line
-   `distance` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** distance along the line
-   `units` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** can be degrees, radians, miles, or kilometers (optional, default `miles`)

**Examples**

```javascript
var line = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "LineString",
    "coordinates": [
      [-77.031669, 38.878605],
      [-77.029609, 38.881946],
      [-77.020339, 38.884084],
      [-77.025661, 38.885821],
      [-77.021884, 38.889563],
      [-77.019824, 38.892368]
    ]
  }
};

var along = turf.along(line, 1, 'miles');

var result = {
  "type": "FeatureCollection",
  "features": [line, along]
};

//=result
```

Returns **Feature<Point>** Point `distance` `units` along the line

---

This module is part of the [Turfjs project](http://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 module individually:

```sh
$ npm install turf-along
```

Or install the Turf module that includes it as a function:

```sh
$ npm install turf
```

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