Module:Logger/doc

This is a documentation subpage for Module:Logger. It contains usage information, categories, and other content that is not part of the original module page.

Module:Logger is required by Module:Enum.

This module is deprecated in favour of using mw.logObject(obj), but is still provided as an alternative. This module is a helper module to be used by other modules; it may not designed to be invoked directly. See GSWiki:Lua/Helper modules for a full list and more information.

Module	Function	Type	Use	Example
Logger	log(table)	table	Deprecated: usemw.logObject(obj) instead. Logs the contents of the table to the console (does not expand subtables). Notes: Assumes all table indices can be represented as strings - using functions or tables as indices will result in non-specific log entries This is best used by adding p.logger = require('Module:Logger') to the top of the module, then calling p.logger.log(obj) in the debug console on the module page This module will only print to the debug console - it has no use when used outside of the development environment and should be removed/commented out before saving	Click to view local logger = require('Module:Logger') local t1 = { 1, 2, 3, 4 } local t2 = { 1, 2, 3, a='a' } local t3 = { a='a', b='b' } local t4 = { a=t1, b=t1, t2, t3 } local t5 = { 1, 2, 3, '4444444444444444444444444444444444444444444444444444444444444444444444444444444444444444444' } local t6 = { '1', '2', a={'12'} } mw.log( p.dumpObject(t1) ) logger.logCleanTable(t2) logger.logCleanTable(t3) logger.logCleanTable(t4, { collapseLimit=60 }) logger.logCleanTable(t5) logger.logObject(t6) -- table#1 (#=4, n=4) { -- 1, -- 2, -- 3, -- 4, -- } -- { 1, 2, 3, a="a" } -- { a="a", b="b" } -- { -- { 1, 2, 3, a="a" }, -- { a="a", b="b" }, -- a = { 1, 2, 3, 4 }, -- b = { 1, 2, 3, 4 }, -- } -- { -- 1, -- 2, -- 3, -- "4444444444444444444444444444444444444444444444444444444444444444444444444444444444444444444", -- } -- table#1 (#=2, n=3) { -- "1", -- "2", -- ["a"] = table#2 (#=1, n=1) { -- "12", -- }, -- }
	deep_log(table)	table	Deprecated: usemw.logObject(obj) instead. Logs the contents of the table to the console, expanding subtables. See above notes.
	dumpObject(table, options)	table, table/nil	Modified version of mw.dumpObject. Default values of the options are: clean = false;     Removes the table#n and expands all tables even if the same table appears multiple times. The output is safe to load again by lua without further processing. Does not work for circular dependencies. indentSize = 2;     Number of spaces/tabs to add for each indent level. useTabs = false;     Use tabs to indent instead of spaces. tabSize = 4;     Used to calculate the collapseLimit. collapseLimit = 0;     Maximum length for collapsing a table onto a single line. collapseArrays = true;     Allow arrays to collapse onto a single line. wrapLongArrays = false;     Keep arrays collapsed and simply continue on a new line if the current line is longer then collapseLimit. collapseObjects = true;     Allow key-value pairs to collapse onto a single line. addEqualSignSpaces = false;     Add spaces around equal signes when the table is collapsed. Non collapsed table always have spaces. addBracketSpaces = true;     Add spaces between the brackets and the data for collapsed tables i.e. { 'data' }. numberPrecision = -1;     Number of decimals. Trailing zeros are trimmed. Negative numbers means let lua decide.
	logObject(table, options)	table, table/nil	Uses dumpObject and prints its result to the console.
	logCleanTable(table, options)	table, table/nil	Uses dumpObject and prints its results to the console but has the following default options changed: clean = true indentSize = 4 collapseLimit = 100 collapseArrays = true collapseObjects = true