Skip to main content

FileTransport <Options>

Hierarchy

Index

Constructors

constructor

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

Properties

readonlylevels

levels: LogLevel[] = []

readonlyoptions

options: Readonly<Required<Options>>

Validated and configured options.

readonlypath

path: Path

optionalstream

stream?: WritableStream

Methods

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>>
  • 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 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
  • Write a message to the file stream, and rotate files once written if necessary.