https://github.com/node-modules/logfilestream
Log stream, including auto rolling feature, support multiprocess `append` write at the same time.
https://github.com/node-modules/logfilestream
Last synced: 11 days ago
JSON representation
Log stream, including auto rolling feature, support multiprocess `append` write at the same time.
- Host: GitHub
- URL: https://github.com/node-modules/logfilestream
- Owner: node-modules
- Created: 2012-09-04T17:19:35.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2020-03-12T03:49:23.000Z (over 5 years ago)
- Last Synced: 2025-05-31T19:56:21.905Z (24 days ago)
- Language: JavaScript
- Size: 76.2 KB
- Stars: 12
- Watchers: 10
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
Awesome Lists containing this project
README
logfilestream
=========
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][cov-image]][cov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/logfilestream.svg?style=flat-square
[npm-url]: https://npmjs.org/package/logfilestream
[travis-image]: https://img.shields.io/travis/node-modules/logfilestream.svg?style=flat-square
[travis-url]: https://travis-ci.org/node-modules/logfilestream
[cov-image]: http://codecov.io/github/node-modules/logfilestream/coverage.svg?branch=master
[cov-url]: http://codecov.io/github/node-modules/logfilestream?branch=master
[david-image]: https://img.shields.io/david/node-modules/logfilestream.svg?style=flat-square
[david-url]: https://david-dm.org/node-modules/logfilestream
[snyk-image]: https://snyk.io/test/npm/logfilestream/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/logfilestream
[download-image]: https://img.shields.io/npm/dm/logfilestream.svg?style=flat-square
[download-url]: https://npmjs.org/package/logfilestream
Log file stream, including auto rolling feature, support multiprocess `append` write at the same time.
## Install
```sh
$ npm i logfilestream --save
```
## Usage
```js
var writestream = logfilestream({
logdir: '/tmp/logs',
nameformat: '[info.]YYYY-MM-DD[.log]',
});
writestream.write('hello');
writestream.write(' world\n');
writestream.end();
```
## Options
```js
/**
* Log stream, auto cut the log file.
*
* log file name is concat with `prename + format + ext`.
*
* @param {Object} options
* - {String} logdir, this dir must exists.
* - {String} nameformat, default is '[info.]YYYY-MM-DD[.log]',
* @see moment().format(): http://momentjs.com/docs/#/displaying/format/
* Also support '{pid}' for process pid.
* - {String} [encoding], default is utf-8, other encoding will encode by iconv-lite
* - {Number} [duration], default is one hour(3600000 ms), must >= 60s.
* - {String} [mode], default is '0666'.
* - {Number} [buffer] buffer duration, default is 1000ms
* - {Boolean} [mkdir] try to mkdir in each cut, make sure dir exist.
* useful when your nameformat like 'YYYY/MM/DD/[info.log]'.
* return {LogStream}
*/
```
## License
(The MIT License)
Copyright(c) 2012 - 2014 fengmk2 .
Copyright(c) 2015 - present node-modules and other contributors.
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.