# pon-task-watch

> Pon task to watch files

Latest version **4.0.1** (published 2020-05-16) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install pon-task-watch
pnpm add pon-task-watch
yarn add pon-task-watch
bun add pon-task-watch
```

## 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 | 4.0.1 |
| Published | 2020-05-16 |
| First published | 2017-04-25 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 34.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Taka Okunishi |
| Maintainers | realglobe |
| Keywords | Pon |

## Links

- npm: https://www.npmjs.com/package/pon-task-watch
- Repository: https://github.com/realglobe-Inc/pon-task-watch
- Homepage: https://github.com/realglobe-Inc/pon-task-watch#readme
- Issues: https://github.com/realglobe-Inc/pon-task-watch/issues
- npm.io page: https://npm.io/package/pon-task-watch

## Dependencies (1)

- [@the-/lock](https://npm.io/package/@the-/lock.md) ^15.4.13

## Recent versions

- 4.0.1 (latest) — 2020-05-16
- 4.0.0 — 2020-04-18
- 2.3.0 — 2018-06-11
- 2.1.1 — 2017-10-30
- 2.0.7 — 2017-07-20
- 2.0.6 — 2017-07-20
- 2.0.5 — 2017-05-31
- 2.0.4 — 2017-05-03
- 2.0.3 — 2017-05-03
- 2.0.2 — 2017-04-26
- 2.0.1 — 2017-04-25

## README

pon-task-watch
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/realglobe-Inc/pon-task-watch
[bd_travis_url]: http://travis-ci.org/realglobe-Inc/pon-task-watch
[bd_travis_shield_url]: http://img.shields.io/travis/realglobe-Inc/pon-task-watch.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/realglobe-Inc/pon-task-watch
[bd_travis_com_shield_url]: https://api.travis-ci.com/realglobe-Inc/pon-task-watch.svg?token=
[bd_license_url]: https://github.com/realglobe-Inc/pon-task-watch/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/realglobe-Inc/pon-task-watch
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/realglobe-Inc/pon-task-watch.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/realglobe-Inc/pon-task-watch.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/realglobe-Inc/pon-task-watch
[bd_gemnasium_shield_url]: https://gemnasium.com/realglobe-Inc/pon-task-watch.svg
[bd_npm_url]: http://www.npmjs.org/package/pon-task-watch
[bd_npm_shield_url]: http://img.shields.io/npm/v/pon-task-watch.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Pon task to watch files

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install pon-task-watch --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const pon = require('pon')
const watch = require('pon-task-watch')

async function tryExample () {
  let run = pon({
    myWatch: watch('src/**/*.txt', (event, filename) => {
      console.log('File changed', filename)
    })
  })

  run('myWatch')
}

tryExample()

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Signature.md.hbs" Start -->

<a name="section-doc-guides-03-signature-md"></a>

Signatures
---------


### `define(filenames, handler, options) -> function`

Define task

| Param | type | Description |
| ---- | --- | ----------- |
| filenames | string&amp;#124;string[] |  Filenames or glob pattern to watch |
| handler | function |  Change handler function |
| options | Object |  Optional settings |
| options.delay | number |  Delay to trigger watch |
| options.events | string |  Target events |



<!-- Section from "doc/guides/03.Signature.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [Apache-2.0 License](https://github.com/realglobe-Inc/pon-task-watch/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [Pon][pon_url]
+ [Realglobe, Inc.][realglobe,_inc__url]

[pon_url]: https://github.com/realglobe-Inc/pon
[realglobe,_inc__url]: http://realglobe.jp

<!-- Links End -->

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