@types/ngeohash/README.md

TypeScript definitions for ngeohash

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

# Summary
This package contains type definitions for ngeohash (https://github.com/sunng87/node-geohash).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ngeohash.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ngeohash/index.d.ts)
````ts
declare namespace ngeohash {
    interface GeographicPoint {
        latitude: number;
        longitude: number;
        error: {
            latitude: number;
            longitude: number;
        };
    }

    type GeographicBoundingBox = [number, number, number, number];
    type NSEW = [number, number];

    function encode(latitude: number | string, longitude: number | string, precision?: number): string;
    function decode(hashstring: string): GeographicPoint;
    function decode_bbox(hashstring: string): GeographicBoundingBox;
    function bboxes(minlat: number, minlon: number, maxlat: number, maxlon: number, precision?: number): string[];
    function neighbor(hashstring: string, direction: NSEW): string;
    function neighbors(hashstring: string): string[];

    function encode_int(latitude: number, longitude: number, bitDepth?: number): number;
    function decode_int(hashinteger: number, bitDepth?: number): GeographicPoint;
    function decode_bbox_int(hashinteger: number, bitDepth?: number): GeographicBoundingBox;
    function bboxes_int(minlat: number, minlon: number, maxlat: number, maxlon: number, bitDepth?: number): number;
    function neighbor_int(hashinteger: number, direction: NSEW, bitDepth?: number): number;
    function neighbors_int(hashinteger: number, bitDepth?: number): number[];
}

declare module "ngeohash" {
    export = ngeohash;
}

````

### Additional Details
 * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
 * Dependencies: none

# Credits
These definitions were written by [Erik Rothoff Andersson](https://github.com/erkie).