@types/which-polygon/README.md

TypeScript definitions for which-polygon

# Installation
> `npm install --save @types/which-polygon`

# Summary
This package contains type definitions for which-polygon (https://github.com/mapbox/which-polygon).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/which-polygon.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/which-polygon/index.d.ts)
````ts
import { FeatureCollection, GeoJsonProperties, Geometry } from "geojson";
import RBush = require("rbush");

declare namespace whichPolygon {
    type Coordinates = [lng: number, lat: number];

    type BBox = [minLat: number, maxLat: number, minLng: number, maxLng: number];

    interface Query<Properties> {
        (coordinates: Coordinates, multi: true): Properties[] | null;
        (coordinates: Coordinates, multi?: false): Properties | null;

        bbox(bbox: BBox): Properties[];

        /** @internal */
        tree: RBush<unknown>;
    }

    type GeoJson<Properties> = FeatureCollection<Geometry, Properties>;
}

/**
 * The input GeoJSON must be a feature collection of polygons or multipolygons.
 * The query returns the properties of the matched polygon feature.
 */
declare function whichPolygon<Properties = GeoJsonProperties>(
    data: whichPolygon.GeoJson<Properties>,
): whichPolygon.Query<Properties>;

export = whichPolygon;

````

### Additional Details
 * Last updated: Thu, 26 Sep 2024 17:08:07 GMT
 * Dependencies: [@types/geojson](https://npmjs.com/package/@types/geojson), [@types/rbush](https://npmjs.com/package/@types/rbush)

# Credits
These definitions were written by [Kyle Hensel](https://github.com/k-yle).