file-timestamp-stream

file-timestamp-stream

This module creates stream.Writable to a file which is automatically rotated based on current time.

Installation

npm install file-timestamp-stream

Usage

Example:

const { FileTimestampStream } = require('file-timestamp-stream')

const stream = new FileTimestampStream({
  path: '%Y-%m-%dT%H.log',
  flags: 'a'
})

Typescript:

import { FileTimestampStream } from 'file-timestamp-stream'

Options

• newFilename is a custom function which returns new filename (default: returns new filename based on path and current time)
• flags is a string with flags for opened stream (default: 'a')
• fs is a custom fs module (optional)
• path is a template for new filenames (default: 'out.log')

Properties

• currentFilename contains last opened filename
• stream contains fs.WriteStream object

Path template format

Path can contain strftime specifiers.

Warning

This module uses internal API of fs.WriteStream: _write and _writev methods directly for maximal performance.

License

Copyright (c) 2017 Piotr Roszatycki [e-mail]

MIT

Changelog

v0.1.0 2017-10-24

• Exports also as a class and namespace and the default.
• Property wstream was renamed to stream.
• Typescript: typings added.