52 lines
1.5 KiB
Markdown
52 lines
1.5 KiB
Markdown
# @turf/boolean-touches
|
|
|
|
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
|
|
|
|
## booleanTouches
|
|
|
|
Boolean-touches true if none of the points common to both geometries
|
|
intersect the interiors of both geometries.
|
|
|
|
### Parameters
|
|
|
|
* `feature1` **([Geometry][1] | [Feature][2]\<any>)** GeoJSON Feature or Geometry
|
|
* `feature2` **([Geometry][1] | [Feature][2]\<any>)** GeoJSON Feature or Geometry
|
|
|
|
### Examples
|
|
|
|
```javascript
|
|
var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
|
|
var point = turf.point([1, 1]);
|
|
|
|
turf.booleanTouches(point, line);
|
|
//=true
|
|
```
|
|
|
|
Returns **[boolean][3]** true/false
|
|
|
|
[1]: https://tools.ietf.org/html/rfc7946#section-3.1
|
|
|
|
[2]: https://tools.ietf.org/html/rfc7946#section-3.2
|
|
|
|
[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
|
|
|
|
<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
|
|
|
|
---
|
|
|
|
This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.
|
|
|
|
### Installation
|
|
|
|
Install this single module individually:
|
|
|
|
```sh
|
|
$ npm install @turf/boolean-touches
|
|
```
|
|
|
|
Or install the all-encompassing @turf/turf module that includes all modules as functions:
|
|
|
|
```sh
|
|
$ npm install @turf/turf
|
|
```
|