FileTransport <Options>

Hierarchy

• Transport<Options>
  • FileTransport
    • RotatingFileTransport

Index

Constructors

• constructor

Properties

• levels
• options
• path
• stream

Methods

• blueprint
• close
• configure
• format
• open
• write

Constructors

constructor

• new FileTransport<Options>(options: Options): FileTransport<Options>

• Overrides Transport.constructor

  Type parameters

  • Options: FileTransportOptions = FileTransportOptions

Properties

readonlylevels

levels: LogLevel[] = []

Inherited from Transport.levels

readonlyoptions

options: Readonly<Required<Options>>

Inherited from Transport.options

Validated and configured options.

readonlypath

path: Path

optionalstream

stream?: WritableStream

Methods

blueprint

• blueprint(schemas: __module): Blueprint<FileTransportOptions>

• Overrides Transport.blueprint

close

• close(commit?: () => void): void

• Close the file stream and trigger the callback when finished.

configure

• configure(options?: Partial<Options> | (options: Required<Options>) => Partial<Options>): Readonly<Required<Options>>

• Inherited from Transport.configure

  Set an options object by merging the new partial and existing options with the defined blueprint, while running all validation checks. Freeze and return the options object.

  object.configure({ name: 'Boost' });
  
  object.configure((prevOptions) => ({
      nestedObject: {
          ...prevOptions.nestedObject,
          some: 'value',
      },
  }));

format

• format(item: LogItem): string

• Inherited from Transport.format

  Format the log item into a message string, and append a trailing newline if missing.

open

• open(): WritableStream

• Open the file stream for writing.

write

• write(message: string): void

• Overrides Transport.write

  Write a message to the file stream, and rotate files once written if necessary.