Class ProfilerStatMetadata

Basic metadata for profiler stat.

Index

Constructors

Properties

_group _name _options _unit

Accessors

group name options unit

Methods

assign clone isEqual isEqual

Constructors

constructor

new ProfilerStatMetadata(
    name?: string,
    options?: EnumValue<ProfilerStatOption>,
    unit?: string,
    group?: string,
): ProfilerStatMetadata
Parameters
- Optionalname: string
- Optionaloptions: EnumValue<ProfilerStatOption>
- Optionalunit: string
- Optionalgroup: string
Returns ProfilerStatMetadata

Properties

`Protected`_group

_group: string

`Protected`_name

_name: string

`Protected`_options

_options: EnumValue<ProfilerStatOption>

`Protected`_unit

_unit: string

Accessors

group

get group(): string
Name of a group used for joint display of stat with other stats. All stats with the same group name should use the same unit and it should be meaningful to add their values together. An example is "Successful HTTP requests" and "Failed HTTP requests"
- we can display them together in one graph and adding them together gives us the total amount of HTTP requests.
Returns string
set group(value: string): void
Parameters
- value: string
Returns void

name

get name(): string

User-friendly name of the stat.

Returns string
set name(value: string): void
Parameters
- value: string
Returns void

options

get options(): EnumValue<ProfilerStatOption>

Option flags describing capabilities of the stat.

Returns EnumValue<ProfilerStatOption>
set options(value: EnumValue<ProfilerStatOption>): void
Parameters
- value: EnumValue<ProfilerStatOption>
Returns void

unit

get unit(): string

Unit of measurement that will be displayed somewhere near the data to further characterize the meaning of the data.

Returns string
set unit(value: string): void
Parameters
- value: string
Returns void

Methods

assign

assign(other: Immutable<ProfilerStatMetadata>): ProfilerStatMetadata
Copies all properties defined by the prototype of ProfilerStatMetadata from other to this instance.
Parameters
- other: Immutable<ProfilerStatMetadata>
Returns ProfilerStatMetadata

clone

clone(): ProfilerStatMetadata

Clones this instance and returns a new ProfilerStatMetadata with identical values.

Returns ProfilerStatMetadata

isEqual

isEqual(
this: Immutable<ProfilerStatMetadata>,
other: Immutable<ProfilerStatMetadata>,
): boolean
Determines if this ProfilerStatMetadata instance is equal to the other instance.
Parameters
- this: Immutable<ProfilerStatMetadata>
- other: Immutable<ProfilerStatMetadata>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<ProfilerStatMetadata>,
rhs: Immutable<ProfilerStatMetadata>,
): boolean
Determines if both ProfilerStatMetadata instances are equal.
Parameters
- lhs: Immutable<ProfilerStatMetadata>
- rhs: Immutable<ProfilerStatMetadata>
Returns boolean