# shp-write-stream

> stream write shapefiles, sorta

Latest version **2.0.0** (published 2017-09-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install shp-write-stream
pnpm add shp-write-stream
yarn add shp-write-stream
bun add shp-write-stream
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2017-09-07 |
| First published | 2017-05-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Maintainers | cwmma |

## Links

- npm: https://www.npmjs.com/package/shp-write-stream
- Repository: https://github.com/calvinmetcalf/shp-write-stream
- Homepage: https://github.com/calvinmetcalf/shp-write-stream#readme
- Issues: https://github.com/calvinmetcalf/shp-write-stream/issues
- npm.io page: https://npm.io/package/shp-write-stream

## Dependencies (3)

- [pump](https://npm.io/package/pump.md) ^1.0.2
- [debug](https://npm.io/package/debug.md) ^2.6.8
- [readable-stream](https://npm.io/package/readable-stream.md) ^2.2.9

## Recent versions

- 2.0.0 (latest) — 2017-09-07
- 1.1.0 — 2017-07-05
- 1.0.0 — 2017-05-18

## README

shp-write-stream
===

Want to create a shapefile in a streaming manner?

Well you can't but this is the next best thing.

```bash
npm install --save shp-stream
```


```js
const shpStream = require('shp-write-stream');

const inputStream = shpStream(schema, makeStream, [options,] callback);
```

Takes 2 arguments and a callback, returns a writable stream.

The stream is an object stream which takes geojson feature objects.

First argument is a schema object which is an array of objects with `name` and `type` values with type being  one of `number`, `character`, `logical`, `date`, `length` may also be specified and for numbers `precision` may be specified as well.

Second argument is a function you need to provide that will be called with 2 arguments, shape type and file extension .e.g. `point` and `dbf` and it needs to return a writable stream where the shapefile component corresponding to that shapetype will be written to.

The options currently it only accepts `preferPoint` which defaults to `true` if set to false then we create a single multipoint shapefile for both points and multipoints, if true (the default) we create a point shapefile for points and a multipoint for multipoints.

The callback is called with 2 arguments, error and headers, the headers need to be put at the beginning of the streams that have been written (hence why you can't truly stream them).  The structure of the header object is at the top level you have a key for each shapetype in the output, and bellow that an object with a key for each extension type with the value being the buffer with the header in it.  The output if there was a polygon and linestring features would be

```js
{
  line: {
    shp: <buffer>,
    shx: <buffer>,
    dbf: <buffer>
  },
  polygon: {
    shp: <buffer>,
    shx: <buffer>,
    dbf: <buffer>
  }
}
```

Acknowledgements
===

Much of this would be impossible without [Tom MacWright's](https://macwright.org/) work on [shp-write](https://github.com/mapbox/shp-write).

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