flog.io

3.2.1 • Public • Published

flog.io

Nested Log Trees // Console And Socket Logging

flog.io is a tool for nested tree logging.
The nested structure allows for a more varied console.log() usage.
Replace your console.log() calls with flog.io.print(), or use them together.


v3.2.0

---added file logging


v3.1.3

---added branch checking of existing flog to prevent circular references


npm install flog.io


Create new logs by:
---with or without a config object
---const flog=require('flog.io')
---let log=new flog.io({config object})

Default Config Object:
{
name:'flog.io'
,readconsole:false -> read console.log() calls
,writeconsole:true -> send to console.log()
,logfile:false -> save a log file
,sockets:[] -> sockets array
,emitname:'flog.io' -> socket emit event name
,parents:[] -> parents array
,children:[] -> children array
}

Functions:
.print(arguments)
.addsocket(socket)
.addchild(child)
.addparent(parent)
.removesocket(socket)
.removechild(child)
.removeparent(parent)

Using print():
---using a comma between arguments will start a new line
---replace the use of console.log() with .print(), .print() will write to the console, send over any sockets, save to a log file, and send to any parents
---or use console.log() and declare a flog.io with 'readconsole:true' to read the console.log() and automatically send to any log files, sockets, or parent logs

To use nested tree logging:
---.addchild(child) -> add a child log, the child.print() calls will also call the parent.print()
---.addparent(parent) -> add a parent log, similar to above
---.removechild(child) -> remove a child log
---.removeparent(parent) -> remove a parent log
---parents/children can also be added at instantiation
---Children copy their parents to the child's .print() calls, and those parents will copy their parents to the .print() call, etc
---Create any tree structure you like

Log to file:
---use the config setting 'logfile:true'
---every new flog.io has its own log file
---for now logs can be found in the 'flog.io' module folder

To enable the socket logging:
---.addsocket(socket) -> add a socket to pass print() arguments to using config.emitname
---the receiving socket.on(event,args) event by default is 'emitname:'flog.io''
---sockets can also be added at instantiation

Package Sidebar

Install

npm i flog.io

Weekly Downloads

4

Version

3.2.1

License

MIT

Unpacked Size

17 kB

Total Files

4

Last publish

Collaborators

  • fooeybar