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

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

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/shapefile.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/shapefile/index.d.ts)
````ts
/// <reference types="node" />

import { Feature, FeatureCollection, GeoJsonProperties, GeometryObject } from "geojson";
import { Readable } from "stream";

export interface Options {
    encoding?: string | undefined;
    highWaterMark?: number | undefined;
}
export interface Source<RecordType> {
    bbox: number[];
    read(): Promise<{ done: boolean; value: RecordType }>;
    cancel(): Promise<void>;
}

export type Openable = string | ArrayBuffer | Uint8Array | Readable | ReadableStream;

export function open(shp: Openable, dbf?: Openable, options?: Options): Promise<Source<Feature>>;
export function openShp(source: Openable, options?: Options): Promise<Source<GeometryObject>>;
export function openDbf(source: Openable, options?: Options): Promise<Source<GeoJsonProperties>>;
export function read(shp: Openable, dbf?: Openable, options?: Options): Promise<FeatureCollection>;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: [@types/geojson](https://npmjs.com/package/@types/geojson), [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [ Denis Carriere](https://github.com/DenisCarriere), and [James Bromwell](https://github.com/Thw0rted).