Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents the context object used throughout a merge operation.

It contains central references to the merging such as the options used for merging, the error list, and the logger function.

Hierarchy

  • MergeContext

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

errors

errors:

Gets the current error list of the context.

hasErrors

hasErrors:

Gets whether this context object has any errors or not.

logger

logger:

Gets the logger function being used to display or save logs for this object.

options

options:

Gets the options object set to this context.

Methods

error

  • error(error: string | Error): Error
  • Logs a new error, creating a Error object in case a string is given.

    This error is also stored on the errors property.

    Parameters

    • error: string | Error

      Either a string with the error message or an Error object.

    Returns Error

    The error object, regardless if it was given by parameter or created by the method.

log

  • log(message: string, level?: LogLevel, newLine?: boolean): void
  • Inserts a new log entry.

    Parameters

    • message: string

      Message to be added to the log.

    • Default value level: LogLevel = LogLevel.Information

      Level of the log detail, from log to error.

    • Default value newLine: boolean = true

      Whether to insert a new line on loggers that accept so.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc