StreamTransport

Hierarchy

• Transport<StreamTransportOptions>
  • StreamTransport

Index

Constructors

• constructor

Properties

• levels
• options

Methods

• blueprint
• configure
• format
• write

Constructors

constructor

• new StreamTransport(options: StreamTransportOptions): StreamTransport

• Overrides Transport.constructor

Properties

readonlylevels

levels: LogLevel[] = []

Inherited from Transport.levels

readonlyoptions

options: Readonly<Required<StreamTransportOptions>>

Inherited from Transport.options

Validated and configured options.

Methods

blueprint

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

• Overrides Transport.blueprint

configure

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

• 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.

write

• write(message: string): void

• Overrides Transport.write

  Write a message to the configured stream.