# @types/kdbush

> TypeScript definitions for kdbush

Latest version **3.0.5** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/kdbush
pnpm add @types/kdbush
yarn add @types/kdbush
bun add @types/kdbush
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.5 |
| Published | 2023-11-07 |
| First published | 2017-04-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51436 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/kdbush
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/kdbush
- npm.io page: https://npm.io/package/@types/kdbush

## Recent versions

- 3.0.5 (latest) — 2023-11-07
- 3.0.2 (ts4.1) — 2022-10-27
- 3.0.1 (ts3.8) — 2021-12-24
- 3.0.0 (ts2.0) — 2019-10-10
- 1.0.7 — 2023-11-07
- 1.0.6 — 2023-10-18
- 3.0.4 — 2023-10-18
- 1.0.5 — 2023-09-14
- 3.0.3 — 2023-09-14
- 1.0.4 — 2021-12-24
- 1.0.3 — 2019-10-10
- 1.0.2 — 2018-11-05
- 1.0.1 — 2017-06-23
- 1.0.0 — 2017-04-25

## README

# Installation
> `npm install --save @types/kdbush`

# Summary
This package contains type definitions for kdbush (https://github.com/mourner/kdbush).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/kdbush.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/kdbush/index.d.ts)
````ts
type Points = number[][];
type Get<T> = (point: T) => number;
type ArrayType =
    | typeof Int8Array
    | typeof Int16Array
    | typeof Int32Array
    | typeof Float32Array
    | typeof Float64Array
    | typeof Uint8Array
    | typeof Uint16Array
    | typeof Uint32Array
    | typeof Array;

declare class KDBush<T> {
    constructor(points: Points);
    constructor(points: T[], getX: Get<T>, getY: Get<T>, nodeSize?: number, ArrayType?: ArrayType);
    ids: number[];
    coords: number[];
    nodeSize: number;
    points: T[];
    range(minX: number, minY: number, maxX: number, maxY: number): number[];
    within(x: number, y: number, r: number): number[];
}

export = KDBush;

export as namespace KDBush;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 20:08:00 GMT
 * Dependencies: none

# Credits
These definitions were written by [DenisCarriere](https://github.com/DenisCarriere), and [SangYeob Bono Yu](https://github.com/deminoth).

---
_Source: https://npm.io/package/@types/kdbush · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._