docs/Core.BoundingBoxes.html

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8" />
        <title>BoundingBoxes - Jest-GeoJSON</title>

        <meta
            name="description"
            content="An extended set of matcher functions for the Jest Javascript unit testing framework tailored to evaluating GeoJSON data."
        />

        <meta
            name="keywords"
            content="jest-geojson, jest, testing, validation, geojson, test, gis, assertions, matchers, jest-tests, jest-matchers, javascript, node, npm"
        />
        <meta
            name="keyword"
            content="jest-geojson, jest, testing, validation, geojson, test, gis, assertions, matchers, jest-tests, jest-matchers, javascript, node, npm"
        />

        <meta property="og:title" content="Jest-GeoJSON Documentation" />
        <meta property="og:type" content="article" />
        <meta
            property="og:image"
            content="https://github.com/M-Scott-Lassiter/jest-geojson/blob/main/images/banner.svg"
        />
        <meta property="og:site_name" content="Jest-GeoJSON" />
        <meta property="og:url" content="https://github.com/M-Scott-Lassiter/jest-geojson" />

        <script src="scripts/prettify/prettify.js"></script>
        <script src="scripts/prettify/lang-css.js"></script>
        <!--[if lt IE 9]>
            <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
        <![endif]-->
        <link type="text/css" rel="stylesheet" href="styles/prettify.css" />
        <link type="text/css" rel="stylesheet" href="styles/jsdoc.css" />
        <script src="scripts/nav.js" defer></script>
        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    </head>
    <body>
        <input type="checkbox" id="nav-trigger" class="nav-trigger" />
        <label for="nav-trigger" class="navicon-button x">
            <div class="navicon"></div>
        </label>

        <label for="nav-trigger" class="overlay"></label>

        <nav class="wrap">
            <input type="text" id="nav-search" placeholder="Search" />

            <h2><a href="index.html">Home</a></h2>
            <h2>
                <a
                    href="https://github.com/M-Scott-Lassiter/jest-geojson"
                    target="_blank"
                    class="menu-item"
                    id="repository"
                    >Github Repo</a
                >
            </h2>
            <h3>Namespaces</h3>
            <ul>
                <li><a href="Core.html">Core</a></li>
                <li>
                    <a href="Core.BoundingBoxes.html">Core.BoundingBoxes</a>
                    <ul class="methods">
                        <li data-type="method">
                            <a href="Core.BoundingBoxes.html#.valid2DBoundingBox"
                                >valid2DBoundingBox</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Core.BoundingBoxes.html#.valid3DBoundingBox"
                                >valid3DBoundingBox</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Core.BoundingBoxes.html#.validBoundingBox">validBoundingBox</a>
                        </li>
                    </ul>
                </li>
                <li>
                    <a href="Core.Coordinates.html">Core.Coordinates</a>
                    <ul class="methods">
                        <li data-type="method">
                            <a href="Core.Coordinates.html#.valid2DCoordinate">valid2DCoordinate</a>
                        </li>
                        <li data-type="method">
                            <a href="Core.Coordinates.html#.valid3DCoordinate">valid3DCoordinate</a>
                        </li>
                        <li data-type="method">
                            <a href="Core.Coordinates.html#.validCoordinate">validCoordinate</a>
                        </li>
                    </ul>
                </li>
                <li>
                    <a href="Core.FeatureCollections.html">Core.FeatureCollections</a>
                    <ul class="methods">
                        <li data-type="method">
                            <a href="Core.FeatureCollections.html#.featureCollection"
                                >featureCollection</a
                            >
                        </li>
                    </ul>
                </li>
                <li>
                    <a href="Core.Features.html">Core.Features</a>
                    <ul class="methods">
                        <li data-type="method">
                            <a href="Core.Features.html#.feature">feature</a>
                        </li>
                        <li data-type="method"><a href="Core.Features.html#.hasID">hasID</a></li>
                    </ul>
                </li>
                <li>
                    <a href="Core.Geometries.html">Core.Geometries</a>
                    <ul class="methods">
                        <li data-type="method">
                            <a href="Core.Geometries.html#.anyGeometry">anyGeometry</a>
                        </li>
                        <li data-type="method">
                            <a href="Core.Geometries.html#.geometryCollection"
                                >geometryCollection</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Core.Geometries.html#.lineStringGeometry"
                                >lineStringGeometry</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Core.Geometries.html#.multiLineStringGeometry"
                                >multiLineStringGeometry</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Core.Geometries.html#.multiPointGeometry"
                                >multiPointGeometry</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Core.Geometries.html#.multiPolygonGeometry"
                                >multiPolygonGeometry</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Core.Geometries.html#.pointGeometry">pointGeometry</a>
                        </li>
                        <li data-type="method">
                            <a href="Core.Geometries.html#.polygonGeometry">polygonGeometry</a>
                        </li>
                    </ul>
                </li>
                <li>
                    <a href="Core.Utilities.html">Core.Utilities</a>
                    <ul class="methods">
                        <li data-type="method">
                            <a href="Core.Utilities.html#.commonGeometryValidation"
                                >commonGeometryValidation</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Core.Utilities.html#.validGeoJSON">validGeoJSON</a>
                        </li>
                    </ul>
                </li>
                <li><a href="Matchers.html">Matchers</a></li>
                <li>
                    <a href="Matchers.BoundingBoxes.html">Matchers.BoundingBoxes</a>
                    <ul class="methods">
                        <li data-type="method">
                            <a href="Matchers.BoundingBoxes.html#.isValid2DBoundingBox"
                                >isValid2DBoundingBox</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Matchers.BoundingBoxes.html#.isValid3DBoundingBox"
                                >isValid3DBoundingBox</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Matchers.BoundingBoxes.html#.isValidBoundingBox"
                                >isValidBoundingBox</a
                            >
                        </li>
                    </ul>
                </li>
                <li>
                    <a href="Matchers.Coordinates.html">Matchers.Coordinates</a>
                    <ul class="methods">
                        <li data-type="method">
                            <a href="Matchers.Coordinates.html#.isValid2DCoordinate"
                                >isValid2DCoordinate</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Matchers.Coordinates.html#.isValid3DCoordinate"
                                >isValid3DCoordinate</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Matchers.Coordinates.html#.isValidCoordinate"
                                >isValidCoordinate</a
                            >
                        </li>
                    </ul>
                </li>
                <li>
                    <a href="Matchers.FeatureCollections.html">Matchers.FeatureCollections</a>
                    <ul class="methods">
                        <li data-type="method">
                            <a href="Matchers.FeatureCollections.html#.toBeFeatureCollection"
                                >toBeFeatureCollection</a
                            >
                        </li>
                    </ul>
                </li>
                <li>
                    <a href="Matchers.Features.html">Matchers.Features</a>
                    <ul class="methods">
                        <li data-type="method">
                            <a href="Matchers.Features.html#.toBeFeature">toBeFeature</a>
                        </li>
                        <li data-type="method">
                            <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                        </li>
                        <li data-type="method">
                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
                        </li>
                    </ul>
                </li>
                <li>
                    <a href="Matchers.Functional.html">Matchers.Functional</a>
                    <ul class="methods">
                        <li data-type="method">
                            <a href="Matchers.Functional.html#.toBeValidGeoJSON"
                                >toBeValidGeoJSON</a
                            >
                        </li>
                    </ul>
                </li>
                <li>
                    <a href="Matchers.Geometries.html">Matchers.Geometries</a>
                    <ul class="methods">
                        <li data-type="method">
                            <a href="Matchers.Geometries.html#.toBeAnyGeometry">toBeAnyGeometry</a>
                        </li>
                        <li data-type="method">
                            <a href="Matchers.Geometries.html#.toBeGeometryCollection"
                                >toBeGeometryCollection</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Matchers.Geometries.html#.toBeLineStringGeometry"
                                >toBeLineStringGeometry</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Matchers.Geometries.html#.toBeMultiLineStringGeometry"
                                >toBeMultiLineStringGeometry</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Matchers.Geometries.html#.toBeMultiPointGeometry"
                                >toBeMultiPointGeometry</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Matchers.Geometries.html#.toBeMultiPolygonGeometry"
                                >toBeMultiPolygonGeometry</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Matchers.Geometries.html#.toBePointGeometry"
                                >toBePointGeometry</a
                            >
                        </li>
                        <li data-type="method">
                            <a href="Matchers.Geometries.html#.toBePolygonGeometry"
                                >toBePolygonGeometry</a
                            >
                        </li>
                    </ul>
                </li>
            </ul>
        </nav>

        <div id="main">
            <h1 class="page-title">BoundingBoxes</h1>

            <section>
                <header>
                    <h2>
                        <span class="ancestors"><a href="Core.html">Core</a>.</span>

                        BoundingBoxes
                    </h2>
                </header>

                <article>
                    <div class="container-overview">
                        <dl class="details">
                            <dt class="tag-source">Source:</dt>
                            <dd class="tag-source">
                                <ul class="dummy">
                                    <li>
                                        <a href="typedefinitions.js.html">typedefinitions.js</a>,
                                        <a href="typedefinitions.js.html#line85">line 85</a>
                                    </li>
                                </ul>
                            </dd>
                        </dl>

                        <div class="description usertext">
                            Bounding Box validation functions used within Core.
                        </div>
                    </div>

                    <h3 class="subsection-title">Methods</h3>

                    <h4 class="name" id=".valid2DBoundingBox">
                        <span class="type-signature">(static) </span>valid2DBoundingBox<span
                            class="signature"
                            >(bboxArray)</span
                        ><span class="type-signature"> &rarr; {boolean}</span>
                    </h4>

                    <dl class="details">
                        <dt class="tag-source">Source:</dt>
                        <dd class="tag-source">
                            <ul class="dummy">
                                <li>
                                    <a href="core_boundingBoxes_valid2DBoundingBox.js.html"
                                        >core/boundingBoxes/valid2DBoundingBox.js</a
                                    >,
                                    <a href="core_boundingBoxes_valid2DBoundingBox.js.html#line19"
                                        >line 19</a
                                    >
                                </li>
                            </ul>
                        </dd>

                        <dt class="tag-see">See:</dt>
                        <dd class="tag-see">
                            <ul>
                                <li>
                                    <a
                                        href="https://github.com/M-Scott-Lassiter/jest-geojson/issues/6"
                                        >https://github.com/M-Scott-Lassiter/jest-geojson/issues/6</a
                                    >
                                </li>
                            </ul>
                        </dd>
                    </dl>

                    <div class="description usertext">
                        Verifies a two dimensional bounding box meets WGS-84 and GeoJSON validity
                        requirements.
                    </div>

                    <h5>Example</h5>

                    <pre
                        class="prettyprint"
                    ><code>const goodBBox = valid2DBoundingBox([-10, -20, 20, -10]) // true
const crossesAntimeridian = valid2DBoundingBox([170, -20, -170, 20]) // true

const badExample1 = valid2DBoundingBox([-10, -200, 20, -10]) // throws error for south being out of range
const badExample2 = valid2DBoundingBox([-10, -20, '20', -10]) // throws error for non-numeric value</code></pre>

                    <h5>Parameters:</h5>

                    <table class="params">
                        <thead>
                            <tr>
                                <th>Name</th>

                                <th>Type</th>

                                <th class="last">Description</th>
                            </tr>
                        </thead>

                        <tbody>
                            <tr>
                                <td class="name"><code>bboxArray</code></td>

                                <td class="type">
                                    <span class="param-type">Array.&lt;number></span>
                                </td>

                                <td class="description last">
                                    A WGS-84 array of in format [west, south, east, north].
                                </td>
                            </tr>
                        </tbody>
                    </table>

                    <h5>Throws:</h5>
                    <ul>
                        <li>
                            <dl>
                                <dt>
                                    <div class="param-desc usertext">
                                        Input must be an array of only four elements of type number
                                    </div>
                                </dt>
                                <dd></dd>
                                <dt>
                                    <dl class="param-type">
                                        <dt>Type</dt>
                                        <dd>
                                            <span class="param-type">Error</span>
                                        </dd>
                                    </dl>
                                </dt>
                                <dd></dd>
                            </dl>
                        </li>

                        <li>
                            <dl>
                                <dt>
                                    <div class="param-desc usertext">
                                        Longitude must be a number between -180 and 180
                                    </div>
                                </dt>
                                <dd></dd>
                                <dt>
                                    <dl class="param-type">
                                        <dt>Type</dt>
                                        <dd>
                                            <span class="param-type">RangeError</span>
                                        </dd>
                                    </dl>
                                </dt>
                                <dd></dd>
                            </dl>
                        </li>

                        <li>
                            <dl>
                                <dt>
                                    <div class="param-desc usertext">
                                        Latitude must be a number between -90 and 90
                                    </div>
                                </dt>
                                <dd></dd>
                                <dt>
                                    <dl class="param-type">
                                        <dt>Type</dt>
                                        <dd>
                                            <span class="param-type">RangeError</span>
                                        </dd>
                                    </dl>
                                </dt>
                                <dd></dd>
                            </dl>
                        </li>

                        <li>
                            <dl>
                                <dt>
                                    <div class="param-desc usertext">
                                        North must be greater than or equal to south
                                    </div>
                                </dt>
                                <dd></dd>
                                <dt>
                                    <dl class="param-type">
                                        <dt>Type</dt>
                                        <dd>
                                            <span class="param-type">RangeError</span>
                                        </dd>
                                    </dl>
                                </dt>
                                <dd></dd>
                            </dl>
                        </li>
                    </ul>

                    <h5>Returns:</h5>

                    <div class="param-desc">
                        True if a valid 2D GeoJSON coordinate. If invalid, it will throw an error.
                    </div>

                    <dl class="param-type">
                        <dt>Type</dt>
                        <dd>
                            <span class="param-type">boolean</span>
                        </dd>
                    </dl>

                    <h4 class="name" id=".valid3DBoundingBox">
                        <span class="type-signature">(static) </span>valid3DBoundingBox<span
                            class="signature"
                            >(bboxArray)</span
                        ><span class="type-signature"> &rarr; {boolean}</span>
                    </h4>

                    <dl class="details">
                        <dt class="tag-source">Source:</dt>
                        <dd class="tag-source">
                            <ul class="dummy">
                                <li>
                                    <a href="core_boundingBoxes_valid3DBoundingBox.js.html"
                                        >core/boundingBoxes/valid3DBoundingBox.js</a
                                    >,
                                    <a href="core_boundingBoxes_valid3DBoundingBox.js.html#line22"
                                        >line 22</a
                                    >
                                </li>
                            </ul>
                        </dd>

                        <dt class="tag-see">See:</dt>
                        <dd class="tag-see">
                            <ul>
                                <li>
                                    <a
                                        href="https://github.com/M-Scott-Lassiter/jest-geojson/issues/7"
                                        >https://github.com/M-Scott-Lassiter/jest-geojson/issues/7</a
                                    >
                                </li>
                            </ul>
                        </dd>
                    </dl>

                    <div class="description usertext">
                        Verifies a three dimensional bounding box meets WGS-84 and GeoJSON validity
                        requirements.
                    </div>

                    <h5>Example</h5>

                    <pre
                        class="prettyprint"
                    ><code>const goodBBox = valid3DBoundingBox([-10, -20, -100, 20, 10, 0]) // true
const crossesAntimeridian = valid3DBoundingBox([170, -20, -22.5, 20, -170, 12345.678]) // true

const badExample1 = valid3DBoundingBox([-10, -91, 0, 10, 20, 0]) // throws error for south being out of range
const badExample2 = valid3DBoundingBox([-10, -10, "0", 10, 20, 0]) // throws error for non-numeric value</code></pre>

                    <h5>Parameters:</h5>

                    <table class="params">
                        <thead>
                            <tr>
                                <th>Name</th>

                                <th>Type</th>

                                <th class="last">Description</th>
                            </tr>
                        </thead>

                        <tbody>
                            <tr>
                                <td class="name"><code>bboxArray</code></td>

                                <td class="type">
                                    <span class="param-type">Array.&lt;number></span>
                                </td>

                                <td class="description last">
                                    A six element WGS-84 array of numbers in format [west, south,
                                    depth, east, north, altitude].
                                </td>
                            </tr>
                        </tbody>
                    </table>

                    <h5>Throws:</h5>
                    <ul>
                        <li>
                            <dl>
                                <dt>
                                    <div class="param-desc usertext">
                                        Input must be an array of only four elements of type number
                                    </div>
                                </dt>
                                <dd></dd>
                                <dt>
                                    <dl class="param-type">
                                        <dt>Type</dt>
                                        <dd>
                                            <span class="param-type">Error</span>
                                        </dd>
                                    </dl>
                                </dt>
                                <dd></dd>
                            </dl>
                        </li>

                        <li>
                            <dl>
                                <dt>
                                    <div class="param-desc usertext">
                                        Depth and altitude must be numeric.
                                    </div>
                                </dt>
                                <dd></dd>
                                <dt>
                                    <dl class="param-type">
                                        <dt>Type</dt>
                                        <dd>
                                            <span class="param-type">Error</span>
                                        </dd>
                                    </dl>
                                </dt>
                                <dd></dd>
                            </dl>
                        </li>

                        <li>
                            <dl>
                                <dt>
                                    <div class="param-desc usertext">
                                        Longitude must be a number between -180 and 180
                                    </div>
                                </dt>
                                <dd></dd>
                                <dt>
                                    <dl class="param-type">
                                        <dt>Type</dt>
                                        <dd>
                                            <span class="param-type">RangeError</span>
                                        </dd>
                                    </dl>
                                </dt>
                                <dd></dd>
                            </dl>
                        </li>

                        <li>
                            <dl>
                                <dt>
                                    <div class="param-desc usertext">
                                        Latitude must be a number between -90 and 90
                                    </div>
                                </dt>
                                <dd></dd>
                                <dt>
                                    <dl class="param-type">
                                        <dt>Type</dt>
                                        <dd>
                                            <span class="param-type">RangeError</span>
                                        </dd>
                                    </dl>
                                </dt>
                                <dd></dd>
                            </dl>
                        </li>

                        <li>
                            <dl>
                                <dt>
                                    <div class="param-desc usertext">
                                        North must be greater than or equal to south
                                    </div>
                                </dt>
                                <dd></dd>
                                <dt>
                                    <dl class="param-type">
                                        <dt>Type</dt>
                                        <dd>
                                            <span class="param-type">RangeError</span>
                                        </dd>
                                    </dl>
                                </dt>
                                <dd></dd>
                            </dl>
                        </li>

                        <li>
                            <dl>
                                <dt>
                                    <div class="param-desc usertext">
                                        Altitude must be greater than or equal to depth
                                    </div>
                                </dt>
                                <dd></dd>
                                <dt>
                                    <dl class="param-type">
                                        <dt>Type</dt>
                                        <dd>
                                            <span class="param-type">RangeError</span>
                                        </dd>
                                    </dl>
                                </dt>
                                <dd></dd>
                            </dl>
                        </li>
                    </ul>

                    <h5>Returns:</h5>

                    <div class="param-desc">
                        True if a valid 3D GeoJSON coordinate. If invalid, it will throw an error.
                    </div>

                    <dl class="param-type">
                        <dt>Type</dt>
                        <dd>
                            <span class="param-type">boolean</span>
                        </dd>
                    </dl>

                    <h4 class="name" id=".validBoundingBox">
                        <span class="type-signature">(static) </span>validBoundingBox<span
                            class="signature"
                            >(bboxArray)</span
                        ><span class="type-signature"> &rarr; {boolean}</span>
                    </h4>

                    <dl class="details">
                        <dt class="tag-source">Source:</dt>
                        <dd class="tag-source">
                            <ul class="dummy">
                                <li>
                                    <a href="core_boundingBoxes_validBoundingBox.js.html"
                                        >core/boundingBoxes/validBoundingBox.js</a
                                    >,
                                    <a href="core_boundingBoxes_validBoundingBox.js.html#line24"
                                        >line 24</a
                                    >
                                </li>
                            </ul>
                        </dd>

                        <dt class="tag-see">See:</dt>
                        <dd class="tag-see">
                            <ul>
                                <li>
                                    <a
                                        href="https://github.com/M-Scott-Lassiter/jest-geojson/issues/8"
                                        >https://github.com/M-Scott-Lassiter/jest-geojson/issues/8</a
                                    >
                                </li>
                            </ul>
                        </dd>
                    </dl>

                    <div class="description usertext">
                        Verifies either a two or three dimensional bounding box meets WGS-84 and
                        GeoJSON validity requirements.
                    </div>

                    <h5>Example</h5>

                    <pre
                        class="prettyprint"
                    ><code>const good2DBBox = validBoundingBox([-10, -20, 20, -10]) // true
const good3DBBox = validBoundingBox([-10, -20, -100, 20, 10, 0]) // true

const badExample1 = validBoundingBox([-10, -91, 10, 20]) // throws error for south being out of range
const badExample2 = validBoundingBox([-10, -10, "0", 10, 20, 0]) // throws error for non-numeric value</code></pre>

                    <h5>Parameters:</h5>

                    <table class="params">
                        <thead>
                            <tr>
                                <th>Name</th>

                                <th>Type</th>

                                <th class="last">Description</th>
                            </tr>
                        </thead>

                        <tbody>
                            <tr>
                                <td class="name"><code>bboxArray</code></td>

                                <td class="type">
                                    <span class="param-type">Array.&lt;number></span>
                                </td>

                                <td class="description last">
                                    A WGS-84 array of [west, south, east, north] or [west, south,
                                    depth, east, north, altitude]. Longitude must be between -180 to
                                    180. Latitude must be between -90 to 90. If present, depth and
                                    altitude must be a number between -Infinity to Infinity. The
                                    standard does not specify units altitude represents (i.e.
                                    meters, feet, etc.).
                                </td>
                            </tr>
                        </tbody>
                    </table>

                    <h5>Throws:</h5>

                    <dl>
                        <dt>
                            <div class="param-desc usertext">
                                Input must be an array of only four or six elments
                            </div>
                        </dt>
                        <dd></dd>
                        <dt>
                            <dl class="param-type">
                                <dt>Type</dt>
                                <dd>
                                    <span class="param-type">Error</span>
                                </dd>
                            </dl>
                        </dt>
                        <dd></dd>
                    </dl>

                    <h5>Returns:</h5>

                    <div class="param-desc">
                        True if a valid 2D or 3D GeoJSON bounding box. If invalid, it will throw an
                        error.
                    </div>

                    <dl class="param-type">
                        <dt>Type</dt>
                        <dd>
                            <span class="param-type">boolean</span>
                        </dd>
                    </dl>
                </article>
            </section>
        </div>

        <br class="clear" />

        <footer>
            Documentation generated by
            <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> using the
            <a href="https://github.com/clenemt/docdash">docdash</a> theme.
        </footer>

        <script>
            prettyPrint()
        </script>
        <script src="scripts/polyfill.js"></script>
        <script src="scripts/linenumber.js"></script>

        <script src="scripts/search.js" defer></script>
    </body>
</html>