Fathom v0.2

component fathom.util

This component provides APIs for various helpers and utilities.

Methods

Methods Returns Description
baseline( metric ) void static This function returns baseline values for a given metric.
(1) Suboptimal naming. (2) The ffxMemory baseline should get renamed to browserMemory.

Parameters:

  • metric <string> The metric to query. Supported metrics include "cpu", "ffxMemory", "traffic", and "wifi".
log( data ) void static A logging helper routine.
Where does this log to? Seems it should have a notion of log levels.

Parameters:

  • data <string> Data to log.
os( ) string static This function returns client OS information.
(1) Suboptimal naming. (2) Can be folded into systemInfo?

Returns:

  • <string> OS information.
processNextEvent( ) void static This is an API invocation to process the next event on the current thread.

Returns:

  • <void> This function does not return any value.
systemInfo( param ) string static This function various system information strings.
(1) Suboptimal naming.

Parameters:

  • param <string> A keyword indicating the kind of information of interest. Possible values: "architecture", "fullhostname", "hostname", "release", and "system".
    • Returns:

      • <string> Informative string.
test( ) string static This is an API invocation test function.

Returns:

  • <string> This function returns the string "test" when successful.