Skip to content

Commit

Permalink
file options version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
rcastells committed Oct 27, 2018
1 parent a6fd230 commit 822b8a5
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion FileStreamRotator.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ var EventEmitter = require('events');
* stream in a loop, if the application terminates or log rotates, data pending to be flushed might be lost.
*
* - `file_options` An object passed to the stream. This can be used to specify flags, encoding, and mode.
* See https://nodejs.org/api/all.thml#fs_fs_createwritestream_path_options. Default `{ flags: 'a' }`.
* See https://nodejs.org/api/fs.html#fs_fs_createwritestream_path_options. Default `{ flags: 'a' }`.
*
* To use with Express / Connect, use as below.
*
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ npm install file-stream-rotator
It can be a number of files or number of days. If using days, add 'd' as the suffix.
- *audit_file* Location to store the log audit file. If not set, it will be stored in the root of the application.
- *end_stream* End stream (true) instead of the destroy (default: false). Set value to true if when writing to the
stream in a loop, if the application terminates or log rotates, data pending to be flushed might be lost.
stream in a loop, if the application terminates or log rotates, data pending to be flushed might be lost.
- *file_options* An object passed to the stream. This can be used to specify flags, encoding, and mode.
See https://nodejs.org/api/fs.html#fs_fs_createwritestream_path_options. Default `{ flags: 'a' }`.


## Example Usage
Expand Down Expand Up @@ -124,6 +126,7 @@ Thanks to the contributors below for raising PRs and everyone else that has rais
* [Matt Berther](https://github.com/mattberther)
* [nickbug](https://github.com/nickbug)
* [André Farzat](https://github.com/andrefarzat)
* [Thibault.P](https://github.com/DrPlop)

## License

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "file-stream-rotator",
"version": "0.4.0",
"version": "0.4.1",
"description": "Automated stream rotation useful for log files",
"main": "FileStreamRotator.js",
"scripts": {
Expand Down

0 comments on commit 822b8a5

Please sign in to comment.