@turf/line-offset/dist/esm/index.d.ts

Takes a line and returns a line at offset by the specified distance.

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

/**
 * Takes a {@link LineString|line} and returns a {@link LineString|line} at offset by the specified distance.
 *
 * @function
 * @param {Geometry|Feature<LineString|MultiLineString>} geojson input GeoJSON
 * @param {number} distance distance to offset the line (can be of negative value)
 * @param {Object} [options={}] Optional parameters
 * @param {Units} [options.units='kilometers'] Supports all valid Turf {@link https://turfjs.org/docs/api/types/Units Units}.
 * @returns {Feature<LineString|MultiLineString>} Line offset from the input line
 * @example
 * var line = turf.lineString([[-83, 30], [-84, 36], [-78, 41]], { "stroke": "#F00" });
 *
 * var offsetLine = turf.lineOffset(line, 2, {units: 'miles'});
 *
 * //addToMap
 * var addToMap = [offsetLine, line]
 * offsetLine.properties.stroke = "#00F"
 */
declare function lineOffset<T extends LineString | MultiLineString>(geojson: Feature<T> | T, distance: number, options?: {
    units?: Units;
}): Feature<T>;

export { lineOffset as default, lineOffset };