Interface ICommonStats<T>

Type Parameters

T

Hierarchy

ICommonStats
- ITextStats
- IHistStats

Index

Properties

Methods

[toPrimitive]

Properties

Readonly count

count: number

number of items in the array

Readonly depth

depth: number

in case of nested arrays what is the max nested depth

Readonly flatCount

flatCount: number

number of items in the array

Readonly flatItems

flatItems: readonly T[]

the items in this stats

Readonly flatMissing

flatMissing: number

number of missing items in the array

Readonly items

items: readonly (T | Set<T> | (readonly T[]))[]

the items in this stats

Readonly missing

missing: number

number of missing items in the array

Methods

[toPrimitive]

[toPrimitive](hint: "default"): string
[toPrimitive](hint: "string"): string
[toPrimitive](hint: "number"): number
[toPrimitive](hint: string): string | number

- Defined in build/repo/packages/components/src/math/common.ts:69
Converts a Stats object to a string.

Parameters
- hint: "default"
Returns string
- Defined in build/repo/packages/components/src/math/common.ts:73
Converts a Stats object to a string.

Parameters
- hint: "string"
Returns string
- Defined in build/repo/packages/components/src/math/common.ts:77
Converts a Stats object to a number.

Parameters
- hint: "number"
Returns number
- Defined in build/repo/packages/components/src/math/common.ts:86
Converts a Stats object to a string or number.

throws
{TypeError} If 'hint' was given something other than "number", "string", or "default".

Parameters
- hint: string
  
  The strings "number", "string", or "default" to specify what primitive to return.
Returns string | number
A number if 'hint' was "number", a string if 'hint' was "string" or "default".

Generated using TypeDoc