Skip to content

Commit

Permalink
Merge pull request #43 from tprpc/master
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
lucagrulla committed Aug 9, 2016
2 parents 3c6b3b0 + 9f6d224 commit 6b7ca02
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Expand Up @@ -45,14 +45,14 @@ new Tail(fileToTail)
Optional parameters can be passed via a hash:

```javascript
var options= {lineSeparator: /[\r]{0,1}\n/, fromBeginning: false, watchOptions: {}, follow: true, logger: console}
var options= {separator: /[\r]{0,1}\n/, fromBeginning: false, watchOptions: {}, follow: true, logger: console}
new Tail(fileToTail, options)
```

# Available parameters:

* `lineSeparator`: the line separator token (default `/[\r]{0,1}\n/` to handle linux/mac (9+)/windows)
* `watchOptions`: the full set of options that can be passed to `fs.watch` as per node documentation (default: {})
* `separator`: the line separator token (default `/[\r]{0,1}\n/` to handle linux/mac (9+)/windows)
* `fsWatchOptions`: the full set of options that can be passed to `fs.watch` as per node documentation (default: {})
* `fromBeginning`: forces the tail of the file from the very beginning of it instead of from the first new line that will be appended (default: `false`)
* `follow`: simulate `tail -F` option. In the case the file is moved/renamed (or logrotated), if set to `true` `tail` will try to start tailing again after a 1 second delay, if set to `false` it will just emit an error event (default: `true`)
* `logger`: a logger object(default: no logger). The passed logger has to respond to two methods:
Expand Down Expand Up @@ -80,4 +80,4 @@ Tail is written in [CoffeeScript](http://jashkenas.github.com/coffee-script/).
The Cakefile generates the javascript that is then published to npm.

#License
MIT. Please see License file for more details.
MIT. Please see License file for more details.

0 comments on commit 6b7ca02

Please sign in to comment.