This package has been deprecated

Author message:

Module has been renamed to @turf/nearest-point

@turf/nearest

nearest

Takes a reference point and a FeatureCollection of Features with Point geometries and returns the point from the FeatureCollection closest to the reference. This calculation is geodesic.

Parameters

• targetPoint (Geometry | Feature<Point> | Array<number>) the reference point
• points FeatureCollection<Point> against input point set

Examples

var targetPoint = turf.point([28.965797, 41.010086], {"marker-color": "#0F0"});
var points = turf.featureCollection([
    turf.point([28.973865, 41.011122]),
    turf.point([28.948459, 41.024204]),
    turf.point([28.938674, 41.013324])
]);

var nearest = turf.nearest(targetPoint, points);

//addToMap
var addToMap = [targetPoint, points, nearest];
nearest.properties['marker-color'] = '#F00';

Returns Feature<Point> the closest point in the set to the reference point

---

This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

Installation

Install this module individually:

$ npm install @turf/nearest

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

$ npm install @turf/turf