bare-file-logger

stable

bare-file-logger — File system logger for Bare.

npm i bare-file-logger

Usage

const FileLog = require('bare-file-logger')

const log = new FileLog('my-logs.txt')

log.info('Hello %s', 'world!')

_Source

Construct a new FileLog that writes to the file at path.

Parameters

Parameter	Type	Default	Description
`path`	`string`	—	Path to the log file; opened for appending, and created if it does not exist.
`options?`	`FileLogOptions`	—	Options controlling log rotation; see `FileLogOptions`.

_Source

Writes a single log line: the padded label, an ISO-8601 timestamp, and the formatted data, terminated by a newline.

Parameters

Parameter	Type	Default	Description
`label`	`string`	—	A short severity label, right-padded to five characters (e.g. `info`, `error`), prefixed to the line ahead of an ISO-8601 timestamp.
`data`	`unknown[]`	—	Values to format into the log message, using the same formatting as `console.log`.

_Source

Closes the underlying file descriptor and stops the rotation timer. Safe to call more than once.

interface FileLogOptions {
  maxSize?: number
  rotate?: (path: string) => string
  rotateInterval?: number
}

_Source

interface FileLogEvents extends EventMap {
  rotate: [path: string, archived: string | null]
}

_Source