RotatingFileTransportOptions

Hierarchy

• FileTransportOptions
  • RotatingFileTransportOptions

Index

Properties

• eol
• format
• gzip
• levels
• maxSize
• path
• rotation

Properties

optionaleol

eol?: string

Inherited from FileTransportOptions.eol

End of line character to append to a message. Defaults to os.EOL.

optionalformat

format?: Formatter

Inherited from FileTransportOptions.format

Function to format a log item into a message string. Default is transport dependent.

optionalgzip

gzip?: boolean

Inherited from FileTransportOptions.gzip

Apply gzip compression to the write stream.

levels

levels: LogLevel[]

Inherited from FileTransportOptions.levels

List of log levels to only write messages for.

optionalmaxSize

maxSize?: number

Inherited from FileTransportOptions.maxSize

Maximum file size before rotating file. Will create a backup and truncate the current file. Defaults to 10mb.

path

path: PortablePath

Inherited from FileTransportOptions.path

Absolute file system path for the intended log file.

rotation

rotation: Rotation

Period in which to rotate files. Will append a timestamp to the rotated log file.