Wondering what’s next for npm?Check out our public roadmap! »

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

    6.3.0 • Public • Published

    @turf/boolean-within

    booleanWithin

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

    Parameters

    Examples

    var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
    var point = turf.point([1, 2]);
    
    turf.booleanWithin(point, line);
    //=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-within

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

    $ npm install @turf/turf

    Install

    npm i @turf/[email protected]

    Version

    6.3.0

    License

    MIT

    Unpacked Size

    20.8 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar