abstractTransport <Options>

Hierarchy

• Contract<Options>
  • Transport
    • ConsoleTransport
    • FileTransport
    • StreamTransport

Implements

• Transportable

Index

Constructors

• constructor

Properties

• levels
• options

Methods

• blueprint
• configure
• format
• write

Constructors

constructor

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

• Overrides Contract<Options>.constructor

  Type parameters

  • Options: TransportOptions

Properties

readonlylevels

levels: LogLevel[] = []

Implementation of Transportable.levels

readonlyoptions

options: Readonly<Required<Options>>

Inherited from Contract.options

Validated and configured options.

Methods

blueprint

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

• Overrides Contract.blueprint

configure

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

• Inherited from Contract.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

• Implementation of Transportable.format

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

abstractwrite

• write(message: string, item: LogItem): void | Promise<void>

• Implementation of Transportable.write

  Write the formatted message according to the transport.