@haxall/haxall
    Preparing search index...

    Class Log

    Log provides a simple, but standardized mechanism for logging.

    See docLang::Logging for details and examples.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Generate a LogLevel.debug log entry.

      Parameters

      • msg: string
      • Optionalerr: Err

      Returns void

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Generate a LogLevel.err log entry.

      Parameters

      • msg: string
      • Optionalerr: Err

      Returns void

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Generate a LogLevel.info log entry.

      Parameters

      • msg: string
      • Optionalerr: Err

      Returns void

    • Return if debug level is enabled.

      Returns boolean

    • Return if this log is enabled for the specified level.

      Parameters

      Returns boolean

    • Return if error level is enabled.

      Returns boolean

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Return if info level is enabled.

      Returns boolean

    • Return if warn level is enabled.

      Returns boolean

    • The log level field defines which log entries are reported versus ignored. Anything which equals or is more severe than the log level is logged. Anything less severe is ignored. If the level is set to silent, then logging is disabled.

      Returns LogLevel

    • The log level field defines which log entries are reported versus ignored. Anything which equals or is more severe than the log level is logged. Anything less severe is ignored. If the level is set to silent, then logging is disabled.

      Parameters

      Returns void

    • Publish a log entry. The convenience methods err, warn info, and debug all route to this method for centralized handling. The standard implementation is to call each of the installed handlers if the specified level is enabled.

      Parameters

      Returns void

    • Return name of the log.

      Returns string

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return name.

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • Generate a LogLevel.warn log entry.

      Parameters

      • msg: string
      • Optionalerr: Err

      Returns void

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Install a handler to receive callbacks on logging events. If the handler func is not immutable, then throw NotImmutableErr.

      Parameters

      • handler: (arg0: LogRec) => void

      Returns void

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void

    • Find a registered log by name. If the log doesn't exist and checked is false then return null, otherwise throw Err.

      Parameters

      • name: string
      • Optionalchecked: boolean

      Returns Log

    • Find an existing registered log by name or if not found then create a new registered Log instance with the given name. Name must be valid according to Uri.isName otherwise NameErr is thrown.

      Parameters

      • name: string

      Returns Log

    • List all the handler functions installed to process log events.

      Returns List<(arg0: LogRec) => void>

    • Return a list of all the active logs which have been registered since system startup.

      Returns List<Log>

    • Create a new log by name. The log is added to the VM log registry only if register is true. If register is true and a log has already been created for the specified name then throw ArgErr. Name must be valid according to Uri.isName otherwise NameErr is thrown.

      Parameters

      • name: string
      • register: boolean
      • ...args: unknown[]

      Returns Log

    • Uninstall a log handler.

      Parameters

      • handler: (arg0: LogRec) => void

      Returns void