exchange-sdk/docs/classes/_candle_.candleavl.md

@hanzo/matching-engine › Globals › "Candle" › CandleAVL

Class: CandleAVL

a map collection for candles with the same intervals

Hierarchy

• AVLTree‹number, Candle›

  ↳ CandleAVL

Index

Constructors

• constructor

Properties

• interval
• size
• timeFrame

Methods

• at
• clear
• contains
• destroy
• find
• forEach
• insert
• isBalanced
• isEmpty
• keys
• load
• max
• maxNode
• min
• minNode
• next
• pop
• prev
• range
• remove
• timeSlice
• toString
• tradesToCandles
• values

Constructors

constructor

+ new CandleAVL(interval: CandleInterval): CandleAVL

Overrides void

Defined in Candle.ts:22

Parameters:

Name	Type	Description
interval	CandleInterval	candle interval for children

Returns: CandleAVL

Properties

interval

• interval: CandleInterval

Defined in Candle.ts:21

---

size

• size: number

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:15

---

Private timeFrame

• timeFrame: string

Defined in Candle.ts:22

Methods

at

▸ at(index: number): Node‹number, Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:19

Parameters:

Name	Type
index	number

Returns: Node‹number, Candle›

---

clear

▸ clear(): AVLTree‹number, Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:37

Returns: AVLTree‹number, Candle›

---

contains

▸ contains(key: number): boolean

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:20

Parameters:

Name	Type
key	number

Returns: boolean

---

destroy

▸ destroy(): AVLTree‹number, Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:36

Returns: AVLTree‹number, Candle›

---

find

▸ find(key: number): Node‹number, Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:18

Parameters:

Name	Type
key	number

Returns: Node‹number, Candle›

---

forEach

▸ forEach(callback: ForEachCallback‹number, Candle›): AVLTree‹number, Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:29

Parameters:

Name	Type
callback	ForEachCallback‹number, Candle›

Returns: AVLTree‹number, Candle›

---

insert

▸ insert(key: number, data?: Value): void

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:16

Parameters:

Name	Type
key	number
data?	Value

Returns: void

---

isBalanced

▸ isBalanced(): boolean

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:34

Returns: boolean

---

isEmpty

▸ isEmpty(): boolean

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:21

Returns: boolean

---

keys

▸ keys(): Array‹number›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:22

Returns: Array‹number›

---

load

▸ load(keys: Array‹number›, values?: Array‹Candle›): AVLTree‹number, Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:31

Parameters:

Name	Type
keys	Array‹number›
values?	Array‹Candle›

Returns: AVLTree‹number, Candle›

---

max

▸ max(): number

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:26

Returns: number

---

maxNode

▸ maxNode(): Node‹number, Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:28

Returns: Node‹number, Candle›

---

min

▸ min(): number

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:25

Returns: number

---

minNode

▸ minNode(): Node‹number, Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:27

Returns: Node‹number, Candle›

---

next

▸ next(node: Node‹number, Candle›): Node‹number, Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:33

Parameters:

Name	Type
node	Node‹number, Candle›

Returns: Node‹number, Candle›

---

pop

▸ pop(): Node‹number, Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:24

Returns: Node‹number, Candle›

---

prev

▸ prev(node: Node‹number, Candle›): Node‹number, Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:32

Parameters:

Name	Type
node	Node‹number, Candle›

Returns: Node‹number, Candle›

---

range

▸ range(minKey: number, maxKey: number, visit: TraverseCallback‹number, Candle›, context?: any): AVLTree‹number, Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:30

Parameters:

Name	Type
minKey	number
maxKey	number
visit	TraverseCallback‹number, Candle›
context?	any

Returns: AVLTree‹number, Candle›

---

remove

▸ remove(key: number): Node‹number, Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:17

Parameters:

Name	Type
key	number

Returns: Node‹number, Candle›

---

timeSlice

▸ timeSlice(startTime: number, endTime: number, limit: number): Candle[]

Defined in Candle.ts:65

returns the candles withing a certain time range

Parameters:

Name	Type	Default	Description
startTime	number	-	lower time bound
endTime	number	-	higher time bound
limit	number	1000	-

Returns: Candle[]

an array of candles

---

toString

▸ toString(): string

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:35

Returns: string

---

tradesToCandles

▸ tradesToCandles(trades: Trade[]): CandleAVL

Defined in Candle.ts:42

process trades into candles

Parameters:

Name	Type	Description
trades	Trade[]	a list of trades to turn into candles

Returns: CandleAVL

return this to make it chainable

---

values

▸ values(): Array‹Candle›

Inherited from void

Defined in /home/groot/matching-engine/node_modules/avl/src/index.d.ts:23

Returns: Array‹Candle›