Class Period

Hierarchy (View Summary)

TechnicalIndicator<PeriodResult, BigSource>
- Period

Index

Constructors

constructor

Properties

interval

Accessors

highest isStable lowest

Methods

add getResult getResultOrThrow replace update updates

Constructors

constructor

new Period(interval: number): Period
Parameters
- interval: number
Returns Period
Overrides TechnicalIndicator.constructor
- Defined in util/Period.ts:33

Properties

`Readonly`interval

interval: number

Accessors

highest

get highest(): undefined | Big
Returns undefined | Big
- Defined in util/Period.ts:25

isStable

get isStable(): boolean
Returns boolean
Inherited from TechnicalIndicator.isStable
- Defined in Indicator.ts:35

lowest

get lowest(): undefined | Big
Returns undefined | Big
- Defined in util/Period.ts:29

Methods

add

add(input: BigSource): null | PeriodResult
Parameters
- input: BigSource
Returns null | PeriodResult
Inherited from TechnicalIndicator.add
- Defined in Indicator.ts:39

getResult

getResult(): null | PeriodResult
Returns null | PeriodResult
Inherited from TechnicalIndicator.getResult
- Defined in Indicator.ts:19

getResultOrThrow

getResultOrThrow(): PeriodResult
Returns PeriodResult
Inherited from TechnicalIndicator.getResultOrThrow
- Defined in Indicator.ts:27

replace

replace(input: BigSource): null | PeriodResult
Parameters
- input: BigSource
Returns null | PeriodResult
Inherited from TechnicalIndicator.replace
- Defined in Indicator.ts:43

update

update(value: BigSource, replace: boolean): null | { highest: Big; lowest: Big }
Parameters
- value: BigSource
- replace: boolean
Returns null | { highest: Big; lowest: Big }
Overrides TechnicalIndicator.update
- Defined in util/Period.ts:38

updates

updates(
inputs: readonly BigSource[],
replace?: boolean,
): (null | PeriodResult)[]
Parameters
- inputs: readonly BigSource[]
- replace: boolean = false
Returns (null | PeriodResult)[]
Inherited from TechnicalIndicator.updates
- Defined in Indicator.ts:49

On This Page