faastjs.faastmodule.stats.md

April 5, 2024 ยท View on GitHub

faastjs > FaastModule > stats

FaastModule.stats() method

Statistics for a specific function or the entire faast.js module.

Signature:

stats(functionName?: string): FunctionStats;

Parameters

Parameter

Type

Description

functionName

string

(Optional) The name of the function to retrieve statistics for. If the function does not exist or has not been invoked, a new instance of FunctionStats is returned with zero values. If functionName omitted (undefined), then aggregate statistics are returned that summarize all cloud functions within this faast.js module.

**Returns:**

FunctionStats

an snapshot of FunctionStats at a point in time.