TickList
Utility methods for interacting with sorted lists of ticks
Methods#
getTick#
▸ Static getTick(ticks: readonly Tick[], index: number): Tick
Parameters#
| Name | Type |
|---|---|
ticks | readonly Tick[] |
index | number |
Returns: Tick
Defined in: utils/tickList.ts:50
isAtOrAboveLargest#
▸ Static isAtOrAboveLargest(ticks: readonly Tick[], tick: number): boolean
Parameters#
| Name | Type |
|---|---|
ticks | readonly Tick[] |
tick | number |
Returns: boolean
Defined in: utils/tickList.ts:45
isBelowSmallest#
▸ Static isBelowSmallest(ticks: readonly Tick[], tick: number): boolean
Parameters#
| Name | Type |
|---|---|
ticks | readonly Tick[] |
tick | number |
Returns: boolean
Defined in: utils/tickList.ts:40
nextInitializedTick#
▸ Static nextInitializedTick(ticks: readonly Tick[], tick: number, lte: boolean): Tick
Parameters#
| Name | Type |
|---|---|
ticks | readonly Tick[] |
tick | number |
lte | boolean |
Returns: Tick
Defined in: utils/tickList.ts:83
nextInitializedTickWithinOneWord#
▸ Static nextInitializedTickWithinOneWord(ticks: readonly Tick[], tick: number, lte: boolean, tickSpacing: number): [number, boolean]
Parameters#
| Name | Type |
|---|---|
ticks | readonly Tick[] |
tick | number |
lte | boolean |
tickSpacing | number |
Returns: [number, boolean]
Defined in: utils/tickList.ts:101
validateList#
▸ Static validateList(ticks: Tick[], tickSpacing: number): void
Parameters#
| Name | Type |
|---|---|
ticks | Tick[] |
tickSpacing | number |
Returns: void
Defined in: utils/tickList.ts:20