@turf/boolean-contains
    TypeScript icon, indicating that this package has built-in type declarations

    6.5.0 • Public • Published

    @turf/boolean-contains

    booleanContains

    Boolean-contains returns True if the second geometry is completely contained by the first geometry. The interiors of both geometries must intersect and, the interior and boundary of the secondary (geometry b) must not intersect the exterior of the primary (geometry a). Boolean-contains returns the exact opposite result of the @turf/boolean-within.

    Parameters

    Examples

    var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
    var point = turf.point([1, 2]);
    
    turf.booleanContains(line, point);
    //=true

    Returns boolean true/false


    This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

    Installation

    Install this module individually:

    $ npm install @turf/boolean-contains

    Or install the Turf module that includes it as a function:

    $ npm install @turf/turf

    Diagrams

    esri-contains

    Install

    npm i @turf/boolean-contains

    DownloadsWeekly Downloads

    249,981

    Version

    6.5.0

    License

    MIT

    Unpacked Size

    23.2 kB

    Total Files

    7

    Last publish

    Collaborators

    • twelch
    • jamesmilneruk
    • rowanwins
    • tmcw
    • morganherlocker
    • tcql
    • mdfedderly