# iotdb-transport-fs

> IOTDB Transport for Filesystems

Latest version **3.0.6** (published 2016-09-24) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install iotdb-transport-fs
pnpm add iotdb-transport-fs
yarn add iotdb-transport-fs
bun add iotdb-transport-fs
```

## 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 | 3.0.6 |
| Published | 2016-09-24 |
| First published | 2015-03-28 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | David P. Janes |
| Maintainers | dpjanes |

## Links

- npm: https://www.npmjs.com/package/iotdb-transport-fs
- Repository: https://github.com/dpjanes/iotdb-transport-fs
- Homepage: https://homestar.io
- Issues: https://github.com/dpjanes/iotdb-transport-fs/issues
- npm.io page: https://npm.io/package/iotdb-transport-fs

## Dependencies (7)

- [rx](https://npm.io/package/rx.md) ~4.1.0
- [iotdb](https://npm.io/package/iotdb.md) >=3.0.0
- [watch](https://npm.io/package/watch.md) ~0.19.2
- [mkdirp](https://npm.io/package/mkdirp.md) ~0.5.1
- [rwlock](https://npm.io/package/rwlock.md) ~5.0.0
- [iotdb-errors](https://npm.io/package/iotdb-errors.md) ~3.0.2
- [iotdb-transport](https://npm.io/package/iotdb-transport.md) ~3.0.10

## Recent versions

- 3.0.6 (latest) — 2016-09-24
- 3.0.5 — 2016-09-19
- 3.0.4 — 2016-09-19
- 3.0.3 — 2016-09-08
- 3.0.2 — 2016-08-31
- 3.0.1 — 2016-08-19
- 0.0.25 — 2016-05-21
- 0.0.24 — 2016-02-14
- 0.0.23 — 2016-02-04
- 0.0.22 — 2016-02-02
- 0.0.21 — 2016-01-21
- 0.0.20 — 2015-12-30
- 0.0.19 — 2015-12-30
- 0.0.18 — 2015-09-19
- 0.0.17 — 2015-09-19
- … 16 more at https://npm.io/package/iotdb-transport-fs/versions

## README

# iotdb-transport-fs
[IOTDB](https://github.com/dpjanes/node-iotdb) 
[Transporter](https://github.com/dpjanes/node-iotdb/blob/master/docs/transporters.md)
for the File System

<img src="https://raw.githubusercontent.com/dpjanes/iotdb-homestar/master/docs/HomeStar.png" align="right" />

Stores on the Filesystem. Listens for changes to the Filesystem so this is pretty full featured Might need some tweaks for Windows.

# About

This Transporter writes files to the file system in JSON, and
should be able to detect if someone else writes to them.

* [Read more about Transporters](https://github.com/dpjanes/node-iotdb/blob/master/docs/transporters.md)

# Use

See the samples folder for working examples

## Basic

Don't forget your `subscribe`s! Most Transporter methods 
return RX Observables.

Note that the path to the `prefix` will be created.

    const fs_transport = require("iotdb-transport-fs");
    const fs_transporter = fs_transport.make({
        prefix: "some-path",
    });

    fs_transport.put({
        id: "light",
        band: "ostate",
        value: { on: true }
    }).subscribe()

## Flat Transporter

You can create a "flat" transporter if you don't want to create 
a folder for each thing and aren't interested in multiple bands.
Instead of create a folder, the filename for the Thing will be the JSON data

    const fs_transport = require("iotdb-transport-fs");
    const fs_transporter = fs_transport.make({
        prefix: "some-path",
        flat_band: "meta",
    });

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