Stats
A collection of statistic for tracking time or magnitude metrics.
Usage
Just create Stat objects (see Stat
documentation) for various metrics.
import {Stats} from '@probe.gl/stats';
const stats = new Stats({id: 'my-stats'});
const memoryUsage = stats.get('Mem');
const executionTime = stats.get('Time');
memoryUsage.addCount(1024);
executionTime.timeStart();
executionTime.timeEnd();
Methods
constructor
new Stats({id, stats})
id
(String
) - the id of theStats
object.stats
(Stat[] || Object[]
) - the list of stats. Each element in the stats could be eitherStat
object or{name, type}
(type is optional, default iscount
);
get
Retrieve a stat tracker. Create it if it doesn't already exist.
stats.get(name, type)
name
(String
, required) - the name of the stat tracker.type
(String
, optional) - the type of the stat tracker. Default iscount
.
Supported types are described in Stat
Returns the Stat
object identified by name
.
reset
Resets all stats.
stats.reset()
forEach
Iterate over all stats.
stats.forEach(fn)
fn
(Function
, required) - function to call on eachStat
object.
getTable
Return stats in a format suitable for console.table
stats.getTable()