scancode-miro/node_modules/@turf/boolean-point-on-line/dist/cjs/index.d.cts

import { Feature, LineString } from 'geojson';
import { Coord } from '@turf/helpers';

/**
 * Returns true if a point is on a line. Accepts a optional parameter to ignore the
 * start and end vertices of the linestring.
 *
 * @function
 * @param {Coord} pt GeoJSON Point
 * @param {Feature<LineString>} line GeoJSON LineString
 * @param {Object} [options={}] Optional parameters
 * @param {boolean} [options.ignoreEndVertices=false] whether to ignore the start and end vertices.
 * @param {number} [options.epsilon] Fractional number to compare with the cross product result. Useful for dealing with floating points such as lng/lat points
 * @returns {boolean} true/false
 * @example
 * var pt = turf.point([0, 0]);
 * var line = turf.lineString([[-1, -1],[1, 1],[1.5, 2.2]]);
 * var isPointOnLine = turf.booleanPointOnLine(pt, line);
 * //=true
 */
declare function booleanPointOnLine(pt: Coord, line: Feature<LineString> | LineString, options?: {
    ignoreEndVertices?: boolean;
    epsilon?: number;
}): boolean;

export { booleanPointOnLine, booleanPointOnLine as default };