New module @turf/boolean-parallel

[stebogit]

Ref. #735

/**
 * Boolean-Parallel returns True if each segment of `line1` is parallel to the correspondent
 * segment of `line2`
 *
 * @name booleanParallel
 * @param {Geometry|Feature<LineString>} line1 GeoJSON Feature or Geometry
 * @param {Geometry|Feature<LineString>} line2 GeoJSON Feature or Geometry
 * @returns {Boolean} true/false if the lines are parallel
 * @example
 * var line1 = turf.lineString([[0, 0], [0, 1]]);
 * var line2 = turf.lineString([[1, 0], [1, 1]]);
 *
 * turf.booleanParallel(line1, line2);
 * //=true
 */
module.exports = function (line1, line2) {

The module supports only LineStrings (feature or geometry), leaving the user to decide how to apply the comparison among multi lines.

Note: the definition of comparison is based on segment having the same slope on the map plain, i.e. equal rhumb-bearing.
I don't know which definition has, if existing, parallelism on a sphere, but I feel it would be beyond Turf applications.

[DenisCarriere]

@stebogit This private looks great, we should add this to @turf/invariant.

Similar to getGeomType

[stebogit]

Yeah, I always wondered why we didn't have that there 😄

[DenisCarriere]

👍 I'll add it

[DenisCarriere]

👍 Looks great!

[stebogit]

@DenisCarriere out of curiosity why did you remove this?
Many other boolean modules have that, some of them also have

if (process.env.JSTS) t.false(booleanJSTS('within', feature1, feature2), '[false] JSTS - ' + name);

What's their use exactly?

[stebogit]

Woo-hoo!! 😄:+1: