# shapefile-reader

> Streaming Shapefile reader

Latest version **0.1.0** (published 2015-10-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install shapefile-reader
pnpm add shapefile-reader
yarn add shapefile-reader
bun add shapefile-reader
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-10-01 |
| First published | 2015-10-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Emil Bay |
| Maintainers | emilbay |
| Keywords | shapefile-stream, streaming, shapefile, shp, shx, dbf, gis, geo |

## Links

- npm: https://www.npmjs.com/package/shapefile-reader
- Repository: https://github.com/emilbayes/shapefile-reader
- Homepage: https://github.com/emilbayes/shapefile-reader#readme
- Issues: https://github.com/emilbayes/shapefile-reader/issues
- npm.io page: https://npm.io/package/shapefile-reader

## Dependencies (1)

- [inherits](https://npm.io/package/inherits.md) ^2.0.1

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2015-10-01

## README

`shapefile-reader` - WIP
========================

> Streaming Shapefile reader

This is a very early work in progress. Come back later.

Installation
------------

```bash
npm install shapefile-reader
```

Usage
-----

```js
const fs = require('fs')
const shapefileReader = require('shapefile-reader')

shapefileReader({
  shapefile: fs.createReadStream('some-shapefile.shp')
})
.on('header', function (header) {
  // Most interesting is probably header.boundingBox and header.shapeType
})
```

License
-------

* [ISC](LICENSE)
* Test Shapefiles courtesy of Mike Bostock's [`shapefile` module](https://github.com/mbostock/shapefile)

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