Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Function
    • ILog

Callable

  • __call(...content: string[]): void
  • String(s) to log

    Parameters

    • Rest ...content: string[]

    Returns void

Index

Properties

Function

Function: FunctionConstructor

arguments

arguments: any

caller

caller: Function

length

length: number

prototype

prototype: any

Methods

apply

  • apply(this: Function, thisArg: any, argArray?: any): any
  • Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

    Parameters

    • this: Function
    • thisArg: any

      The object to be used as the this object.

    • Optional argArray: any

      A set of arguments to be passed to the function.

    Returns any

bind

  • bind(this: Function, thisArg: any, ...argArray: any[]): any
  • For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

    Parameters

    • this: Function
    • thisArg: any

      An object to which the this keyword can refer inside the new function.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the new function.

    Returns any

call

  • call(this: Function, thisArg: any, ...argArray: any[]): any
  • Calls a method of an object, substituting another object for the current object.

    Parameters

    • this: Function
    • thisArg: any

      The object to be used as the current object.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the method.

    Returns any

data

  • data(data: object): this
  • Append additional data to the log entry

    Note that this can be called multiple times on the same log entry; in such cases, each key-value entry is merged with the previous one.

    You must call .log() a the end of the chain for the log entry to be recorded.

    logger.debug.data({ hello: 'world' }).log();
    
    memberof

    Log

    Parameters

    • data: object

      Key-value of data to add to your log entry

      • [id: string]: any

    Returns this

details

  • details(...content: string[]): this
  • Append additional text information to your log entry

    This is useful for cases where you would need to explain in more details to the operator of your game server what has happened, and, in the case of an error, how to correct the situation.

    You must call .log() a the end of the chain for the log entry to be recorded.

    logger.debug.data({ hello: 'world' }).log();
    
    memberof

    Log

    Parameters

    • Rest ...content: string[]

    Returns this

log

  • log(...content: string[]): void
  • Record the log entry

    The following are essentially equivalent:

    logger.debug.log('hi')
    logger.debug('hi')
    

    Use log whenever you have previously chained data or details method calls:

    logger.error
      .data({hello: 'world'})
      .details('Something awful has occured. Here is how you can fix the situation')
      .log('error. error.error')
    
    memberof

    Log

    Parameters

    • Rest ...content: string[]

    Returns void

toString

  • toString(): string