# manta-dir-watcher > watch a Manta directory for file changes Latest version **1.3.0** (published 2017-05-12) · MPL-2.0 license · 0 weekly downloads ## Install ```sh npm install manta-dir-watcher pnpm add manta-dir-watcher yarn add manta-dir-watcher bun add manta-dir-watcher ``` ## 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 | 1.3.0 | | Published | 2017-05-12 | | First published | 2016-06-29 | | Weekly downloads | 0 | | License | MPL-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 10 | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Joyent | | Maintainers | trentm | | Keywords | manta, watch | ## Links - npm: https://www.npmjs.com/package/manta-dir-watcher - Repository: https://github.com/joyent/node-match-dir-watcher - Homepage: https://github.com/joyent/node-manta-dir-watcher - Issues: https://github.com/joyent/node-match-dir-watcher/issues - npm.io page: https://npm.io/package/manta-dir-watcher ## Dependencies (10) - [manta](https://npm.io/package/manta.md) ^3.0.0 - [bunyan](https://npm.io/package/bunyan.md) ^1.8.1 - [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1 - [rimraf](https://npm.io/package/rimraf.md) ^2.5.2 - [tabula](https://npm.io/package/tabula.md) ^1.8.0 - [vasync](https://npm.io/package/vasync.md) ^1.6.4 - [verror](https://npm.io/package/verror.md) ^1.6.0 - [vstream](https://npm.io/package/vstream.md) ^0.1.0 - [dashdash](https://npm.io/package/dashdash.md) ^1.14.0 - [assert-plus](https://npm.io/package/assert-plus.md) ^1.0.0 ## Recent versions - 1.3.0 (latest) — 2017-05-12 - 1.2.0 — 2016-08-25 - 1.1.0 — 2016-07-05 - 1.0.0 — 2016-06-29 ## README A node.js library to watch a Manta directory for file changes. Minimally you give a `MantaDirWatcher` Manta connection & auth info and a Manta dir to watch, and it will poll the Manta directory and emit an event each time files (a.k.a. a Manta object) or directories are added, removed, or changed. The sweet spot for this module is a Manta directory of relatively few (and if using the sync option, relatively small) files. Optional features: - Glob/regex pattern to limit to a subset of files in the dir (via `filter.name` option). - Limit to just objects or directories (via `filter.type` option). - *Sync* down the files to a local dir (via the `syncDir` option). Limitations: - This module doesn't focus on supporting syncing of large files in Manta. - This doesn't handle recursively descending in Manta dirs. # Install npm install manta-dir-watcher # Usage In node.js code: ```javascript var MantaDirWatcher = require('manta-dir-watcher'); var watcher = new MantaDirWatcher({ dir: , // Optional connection params: // By default Manta connection options are picked up from `MANTA_*` envvars // or `clientOpts` or `client` can be passed in. // Optional params: interval: , filter: { name: , type: <"object" or "directory" to limit to just that type> }, syncDir: , syncDelete: , log: }); watcher.on('data', function (group) { // If using the 'syncDir' option, then the console.log(group); }); ``` CLI: ``` $ ./bin/mwatchdir -i 5 -n '*.txt' /trent.mick/stor/tmp/a ACTION TIMEEVENT MTIME PATH create 2016-06-29T18:13:29.120Z 2016-06-29T18:13:26.672Z /trent.mick/stor/tmp/a/e.txt delete 2016-06-29T18:13:45.494Z - /trent.mick/stor/tmp/a/d.txt create 2016-06-29T18:13:50.981Z 2016-06-29T18:13:46.980Z /trent.mick/stor/tmp/a/f.txt update 2016-06-29T18:14:01.918Z 2016-06-29T18:13:58.210Z /trent.mick/stor/tmp/a/f.txt create 2016-06-29T18:14:07.396Z 2016-06-29T18:14:02.037Z /trent.mick/stor/tmp/a/g.txt ... # Raw JSON event output. $ bin/mwatchdir -n '*.txt' -j /trent.mick/stor/tmp/a {"events":[{"timeEvent":"2016-06-29T23:34:59.939Z","action":"delete","name":"b.txt","path":"/trent.mick/stor/tmp/a/b.txt"}]} {"events":[{"timeEvent":"2016-06-29T23:40:35.615Z","action":"create","name":"foo.txt","path":"/trent.mick/stor/tmp/a/foo.txt","mtime":"2016-06-29T23:40:32.498Z"}]} ``` # Reference ## new MantaDirWatcher(opts) See the "Usage" section above, and the block command for this function in the code for now. ## MantaDirWatcher#close() When done using the watcher, the `close` method should be called to stop polling and to close the underlying Manta client. ## MantaDirWatcher#poke() Poll for changes now (rather than wait until the next scheduled poll time). ## Event: data The `data` event is emitted with whenever a poll finds changes. It looks like this: {"events":[{"timeEvent":"2016-06-29T23:34:59.939Z","action":"create","name":"b.txt","path":"/trent.mick/stor/tmp/a/b.txt","mtime":"2016-06-29T23:34:44.753Z"},{"timeEvent":"2016-06-29T23:34:59.939Z","action":"update","name":"f.txt","path":"/trent.mick/stor/tmp/a/f.txt","mtime":"2016-06-29T23:34:40.123Z"},{"timeEvent":"2016-06-29T23:34:59.939Z","action":"delete","name":"a.txt","path":"/trent.mick/stor/tmp/a/a.txt"}]} There is a single top-level "events" key, which is an array of objects with the following keys: | name | description | | --------- | ----------- | | timeEvent | ISO format timestamp at which the change was processed | | action | One of "update", "create", or "delete". | | name | The file/directory basename. | | path | The file/directory Manta full path. | | mtime | ISO format timestamp of the modification time. This is not present if action="delete". | # License MPL-2. See [LICENSE](./LICENSE). # Developer Notes An example for looking at trace logging (dropping the somewhat noisy manta client traffic): bin/mwatchdir -i 5 -v /trent.mick/stor/tmp/a -n '*.txt' 2>&1 | bunyan -c 'this.component !== "MantaClient"' --- _Source: https://npm.io/package/manta-dir-watcher · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._