Skip to content

Commit

Permalink
Add event docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
treshugart committed Jun 13, 2019
1 parent 8e02475 commit f41884a
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,14 @@ The available options are:
Defaults to `"."`.
- `dry` perform a dry run (does not modify any files, just outputs what would
happen to them).
- `events` an instance of an `EventEmitter` (use via the built-in module:
`require("events")`). Supported events are:
- `file, { action, file }` when a file is affected. The `file` argument is the
file, relative to the `cwd` and `action` is the action that was taken on the
file.
- `info, message` when `info` is logged. The `message` argument is the info
message.
- `warn, message` when `warn` is logged. The `message` is the warning.

```js
const { sync } = require("conartist");
Expand Down

0 comments on commit f41884a

Please sign in to comment.