@futoin/log

Extended log face and service implementations

Usage no npm install needed!

<script type="module">
  import futoinLog from 'https://cdn.skypack.dev/@futoin/log';
</script>

README

About

This is a set of additional implementations of FTN9 AuditLog for various purposes.

Alternative implementation of:

FTN9: FutoIn Interface - AuditLog
Version: 1.0 (client)

Spec: FTN9: FutoIn Interface - AuditLog v1.x

Author: Andrey Galkin

Installation for Node.js

Command line:

$ npm install @futoin/log --save

API documentation

Classes

ConsoleFace ⇐ LogFace

Console-based AuditLog Native interface

Register with ConsoleFace.register().

NOTE: this is a lightweight console logger suitable for stdout-based log collection.

Members

FutoInLog

window.FutoInLog - Browser-only reference to futoin-log

Log

window.futoin.Log - Browser-only reference to futoin-log

Functions

initFace(asi, ccm, [options])

Initial client

ConsoleFace ⇐ LogFace

Console-based AuditLog Native interface

Register with ConsoleFace.register().

NOTE: this is a lightweight console logger suitable for stdout-based log collection.

Kind: global class
Extends: LogFace

new ConsoleFace(impl, info)

ConsoleFace setup

Param Type Default Description
impl SimpleCCMImpl CCM impl
info object info object
info.options object options
[info.options.console] object Console
[info.options.logTime] object false enable timestamps
[info.options.logLevel] object debug debug level

consoleFace.msg(lvl, txt)

Log message

Kind: instance method of ConsoleFace
Overrides: msg

Param Type Description
lvl string debug
txt string message to log

consoleFace.hexdump(lvl, txt, data)

Log message

Kind: instance method of ConsoleFace
Overrides: hexdump

Param Type Description
lvl string debug
txt string message to log
data string raw data

FutoInLog

window.FutoInLog - Browser-only reference to futoin-log

Kind: global variable

Log

window.futoin.Log - Browser-only reference to futoin-log

Kind: global variable

initFace(asi, ccm, [options])

Initial client

Kind: global function

Param Type Description
asi AsyncSteps async steps interface
ccm SimpleCCM CCM interface
[options] object options
[options.logType] string type of logger

documented by jsdoc-to-markdown.