Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

file-timestamp-stream

Package Overview
Dependencies
Maintainers
1
Versions
26
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

file-timestamp-stream

Writing stream with file rotating based on timestamp

  • 2.1.2
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

file-timestamp-stream

Build Status Coverage Status npm

This module creates stream.Writable to a file which is automatically rotated based on current time and uses strftime template for file names.

Requirements

This module requires ES6 with Node >= 6.

Installation

npm install file-timestamp-stream

Additionally for Typescript:

npm install -D @types/node

Transpiling this module with own settings in tsconfig.json:

{
  "compilerOptions": {
    "paths": {
      "file-timestamp-stream": ["node_modules/file-timestamp-stream/src/file-timestamp-stream"]
    }
  }
}

Usage

Example:

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

Typescript:

import FileTimestampStream from 'file-timestamp-stream'

Options

  • 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')

Example:

Basic path based on strftime parameters:

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

newFilename

This method can be overriden in subclass.

The method generates a filename for new files. By default it returns new filename based on path and current time.

Example:

import strftime from 'ultra-strftime'

class MyFileTimestampStream extends FileTimestampStream {
  /** count how many files has been created */
  counter = 0

  // for pure Javascript explicit constructor is necessary
  // constructor (options) { super(options); this.counter = 0 }

  protected newFilename (): string {
    const filename = strftime(this.path)
    if (filename !== this.currentFilename) this.counter++
    return filename
  }
}

const stream = new MyFileTimestampStream({
  path: '%Y-%m-%dT%H:%M.log'
})

Properties

Readonly public properties based on contructor's options:

  • flags
  • fs
  • path

Protected properties for custom subclass:

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

Path template format

Path can contain strftime specifiers.

Warning

This stream have to be closed to free own streams and timers.

License

Copyright (c) 2017-2018 Piotr Roszatycki piotr.roszatycki@gmail.com

MIT

Keywords

FAQs

Package last updated on 18 Sep 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc