index.d.ts 935 B

123456789101112131415161718192021222324
  1. import { Feature, FeatureCollection, LineString, MultiLineString, MultiPolygon, Point, Polygon } from "@turf/helpers";
  2. /**
  3. * Takes a {@link LineString|linestring}, {@link MultiLineString|multi-linestring},
  4. * {@link MultiPolygon|multi-polygon} or {@link Polygon|polygon} and
  5. * returns {@link Point|points} at all self-intersections.
  6. *
  7. * @name kinks
  8. * @param {Feature<LineString|MultiLineString|MultiPolygon|Polygon>} featureIn input feature
  9. * @returns {FeatureCollection<Point>} self-intersections
  10. * @example
  11. * var poly = turf.polygon([[
  12. * [-12.034835, 8.901183],
  13. * [-12.060413, 8.899826],
  14. * [-12.03638, 8.873199],
  15. * [-12.059383, 8.871418],
  16. * [-12.034835, 8.901183]
  17. * ]]);
  18. *
  19. * var kinks = turf.kinks(poly);
  20. *
  21. * //addToMap
  22. * var addToMap = [poly, kinks]
  23. */
  24. export default function kinks<T extends LineString | MultiLineString | Polygon | MultiPolygon>(featureIn: Feature<T> | T): FeatureCollection<Point>;