# @turf/within

> turf within module

Latest version **4.7.3** (published 2017-09-12) · MIT license · 11.6K weekly downloads

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

## Install

```sh
npm install @turf/within
pnpm add @turf/within
yarn add @turf/within
bun add @turf/within
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 4.7.3 |
| Published | 2017-09-12 |
| First published | 2016-07-06 |
| Weekly downloads | 11.6K |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10501 |
| Author | Turf Authors |
| Maintainers | deniscarriere, tcql, morganherlocker, tmcw |
| Keywords | geojson, within, point, polygon, featurecollection |

## Links

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

## Dependencies (2)

- [@turf/inside](https://npm.io/package/@turf/inside.md) ^4.7.3
- [@turf/helpers](https://npm.io/package/@turf/helpers.md) ^4.7.3

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 4.7.3 (latest) — 2017-09-12
- 4.7.1 (lerna-temp) — 2017-09-05
- 3.5.2-alpha.d2c36ee7 (canary) — 2016-11-04
- 4.6.0 — 2017-08-02
- 4.5.2 — 2017-06-30
- 4.5.1 — 2017-06-30
- 4.4.0 — 2017-06-06
- 4.3.0 — 2017-05-12
- 4.2.0 — 2017-04-30
- 4.1.0 — 2017-04-10
- 4.0.1 — 2017-04-05
- 4.0.0 — 2017-04-03
- 3.14.0 — 2017-03-22
- 3.13.0 — 2017-03-12
- 3.10.5 — 2017-03-02
- … 14 more at https://npm.io/package/@turf/within/versions

## README

# @turf/within

# within

Takes a set of [points](http://geojson.org/geojson-spec.html#point) and a set of [polygons](http://geojson.org/geojson-spec.html#polygon) and returns the points that fall within the polygons.

**Parameters**

-   `points` **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** input points
-   `polygons` **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** input polygons

**Examples**

```javascript
var searchWithin = turf.featureCollection([
    turf.polygon([[
        [-46.653,-23.543],
        [-46.634,-23.5346],
        [-46.613,-23.543],
        [-46.614,-23.559],
        [-46.631,-23.567],
        [-46.653,-23.560],
        [-46.653,-23.543]
    ]])
]);
var points = turf.featureCollection([
    turf.point([-46.6318, -23.5523]),
    turf.point([-46.6246, -23.5325]),
    turf.point([-46.6062, -23.5513]),
    turf.point([-46.663, -23.554]),
    turf.point([-46.643, -23.557])
]);

var ptsWithin = turf.within(points, searchWithin);

//addToMap
var addToMap = [points, searchWithin, ptsWithin]
turf.featureEach(ptsWithin, function (currentFeature) {
  currentFeature.properties['marker-size'] = 'large';
  currentFeature.properties['marker-color'] = '#000';
});
```

Returns **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** points that land within at least one polygon

<!-- This file is automatically generated. Please don't edit it directly:
if you find an error, edit the source file (likely index.js), and re-run
./scripts/generate-readmes in the turf project. -->

---

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/within
```

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

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

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