Difference between revisions of "Monitor"

From FirebugWiki
Jump to: navigation, search
(Added description of syntax, hint for needing help and linked back to Command Line API)
m (Added categories)
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{needsHelp}}
 
 
 
Turns on logging for all calls to a function.
 
Turns on logging for all calls to a function.
 +
 +
This means whenever that function is called, a log message will be created inside the [[Console Panel]] showing the function name, the parameters and their values.
  
 
== Syntax ==
 
== Syntax ==
 
<source lang="javascript">
 
<source lang="javascript">
 
monitor(fn)
 
monitor(fn)
 +
</source>
 +
 +
== Parameters ==
 +
=== fn ===
 +
Function to log calls for. '''(required)'''
 +
 +
== Examples ==
 +
Having the following function:
 +
 +
<source lang="javascript" line="true">
 +
function faculty(n)
 +
{
 +
    if (n==1 || n==0)
 +
        return 1;
 +
 +
    var facNumber = 1;
 +
    for (i = 1; i <= n; i++)
 +
        facNumber *= i;
 +
 +
    return facNumber;
 +
}
 +
</source>
 +
 +
<source lang="javascript">
 +
monitor(faculty)
 +
</source>
 +
 +
This enables logging of calls to the function <code>faculty()</code>. So calling this function like <code>faculty(5)</code>, a log message like the following will be created:
 +
 +
<source lang="javascript">
 +
faculty(n=5)
 
</source>
 
</source>
  
 
== See also ==
 
== See also ==
 +
* [[unmonitor]]
 
* [[Command Line API]]
 
* [[Command Line API]]
 +
 +
[[Category:Firebug]]
 +
[[Category:UI]]
 +
[[Category:API]]

Revision as of 16:05, 21 November 2013

Turns on logging for all calls to a function.

This means whenever that function is called, a log message will be created inside the Console Panel showing the function name, the parameters and their values.

Syntax

monitor(fn)

Parameters

fn

Function to log calls for. (required)

Examples

Having the following function:

 1 function faculty(n)
 2 {
 3     if (n==1 || n==0)
 4         return 1;
 5 
 6     var facNumber = 1;
 7     for (i = 1; i <= n; i++)
 8         facNumber *= i;
 9 
10     return facNumber;
11 }
monitor(faculty)

This enables logging of calls to the function faculty(). So calling this function like faculty(5), a log message like the following will be created:

faculty(n=5)

See also