Class StatsModule

Creates a StatsModule

Hierarchy

StatsModule

Index

Constructors

Properties

_dataType _graphType _name

Accessors

dataType graphType name

Methods

Constructors

constructor

new StatsModule(name: string, options: StatsModuleOptions): StatsModule
Parameters
- name: string
  
  The name of the module.
- options: StatsModuleOptions
  
  The options for the module.
Returns StatsModule
- Defined in src/StatsModule.ts:16

Properties

`Private` _dataType

_dataType: "number" | "map"

`Private` _graphType

_graphType: GraphType

`Private` _name

_name: string

Accessors

dataType

get dataType(): "number" | "map"
Gets the data type of the module.

Returns "number" | "map"
- Defined in src/StatsModule.ts:42

graphType

get graphType(): GraphType
Gets the graph type of the module.

Returns GraphType
- Defined in src/StatsModule.ts:34

name

get name(): string
Gets the name of the module.

Returns string
- Defined in src/StatsModule.ts:26

Methods

validInputData

validInputData(data: any): boolean
Validates the data provide to the module.

Returns
Parameters
- data: any
  
  The data to validate.
Returns boolean
- Defined in src/StatsModule.ts:52

Generated using TypeDoc