scancode-miro/node_modules/@turf/line-to-polygon/dist/cjs/index.d.cts

import * as geojson from 'geojson';
import { LineString, MultiLineString, Feature, FeatureCollection, GeoJsonProperties } from 'geojson';

/**
 * Converts (Multi)LineString(s) to Polygon(s).
 *
 * @function
 * @param {FeatureCollection|Feature<LineString|MultiLineString>} lines Features to convert
 * @param {Object} [options={}] Optional parameters
 * @param {Object} [options.properties={}] translates GeoJSON properties to Feature
 * @param {boolean} [options.autoComplete=true] auto complete linestrings (matches first & last coordinates)
 * @param {boolean} [options.orderCoords=true] sorts linestrings to place outer ring at the first position of the coordinates
 * @param {boolean} [options.mutate=false] mutate the original linestring using autoComplete (matches first & last coordinates)
 * @returns {Feature<Polygon|MultiPolygon>} converted to Polygons
 * @example
 * var line = turf.lineString([[125, -30], [145, -30], [145, -20], [125, -20], [125, -30]]);
 *
 * var polygon = turf.lineToPolygon(line);
 *
 * //addToMap
 * var addToMap = [polygon];
 */
declare function lineToPolygon<G extends LineString | MultiLineString>(lines: Feature<G> | FeatureCollection<G> | G, options?: {
    properties?: GeoJsonProperties;
    autoComplete?: boolean;
    orderCoords?: boolean;
    mutate?: boolean;
}): Feature<geojson.MultiPolygon, {
    [name: string]: any;
} | null> | Feature<geojson.Polygon, {
    [name: string]: any;
} | null>;

export { lineToPolygon as default, lineToPolygon };