Skip to main content

Class: LimitOrder

Defined in: orders/limit.ts:14

Extends​

  • default

Extended by​

Constructors​

Constructor​

new LimitOrder(params, updateAmounts?): LimitOrder

Defined in: orders/limit.ts:57

Parameters​

params​

LimitOrderParams

updateAmounts?​

boolean = true

Returns​

LimitOrder

Overrides​

BaseOrder.constructor

Properties​

balanceLimit​

balanceLimit: BalanceLimit

Defined in: orders/limit.ts:19

Overrides​

BaseOrder.balanceLimit


balances​

balances: MarketBalance

Defined in: orders/base.ts:17

Inherited from​

BaseOrder.balances


baseAmount​

baseAmount: BigNumber

Defined in: orders/limit.ts:15


coinraySymbol​

coinraySymbol: string

Defined in: orders/base.ts:9

Inherited from​

BaseOrder.coinraySymbol


errors​

errors: any

Defined in: orders/base.ts:20

Inherited from​

BaseOrder.errors


id​

id: string

Defined in: orders/base.ts:8

Inherited from​

BaseOrder.id


isValid​

isValid: boolean

Defined in: orders/base.ts:21

Inherited from​

BaseOrder.isValid


lockedOn​

lockedOn: string

Defined in: orders/limit.ts:18


makerFee​

makerFee: BigNumber

Defined in: orders/base.ts:15

Inherited from​

BaseOrder.makerFee


minBase​

minBase: BigNumber

Defined in: orders/base.ts:13

Inherited from​

BaseOrder.minBase


minQuote​

minQuote: BigNumber

Defined in: orders/base.ts:14

Inherited from​

BaseOrder.minQuote


orderExternalId?​

optional orderExternalId?: string

Defined in: orders/base.ts:22

Inherited from​

BaseOrder.orderExternalId


orderType​

orderType: OrderType = OrderType.LIMIT

Defined in: orders/limit.ts:21


postOnly?​

optional postOnly?: boolean

Defined in: orders/base.ts:24

Inherited from​

BaseOrder.postOnly


precisionBase​

precisionBase: number

Defined in: orders/base.ts:10

Inherited from​

BaseOrder.precisionBase


precisionPrice​

precisionPrice: number

Defined in: orders/base.ts:12

Inherited from​

BaseOrder.precisionPrice


precisionQuote​

precisionQuote: number

Defined in: orders/base.ts:11

Inherited from​

BaseOrder.precisionQuote


price​

price: BigNumber

Defined in: orders/limit.ts:17


quoteAmount​

quoteAmount: BigNumber

Defined in: orders/limit.ts:16


reduceOnly?​

optional reduceOnly?: boolean

Defined in: orders/base.ts:23

Inherited from​

BaseOrder.reduceOnly


side​

side: OrderSide

Defined in: orders/base.ts:19

Inherited from​

BaseOrder.side


takerFee​

takerFee: BigNumber

Defined in: orders/base.ts:16

Inherited from​

BaseOrder.takerFee


timeInForce?​

optional timeInForce?: TimeInForce

Defined in: orders/base.ts:25

Inherited from​

BaseOrder.timeInForce

Methods​

constraints()​

constraints(): object

Defined in: orders/limit.ts:23

Returns​

object

baseAmount​

baseAmount: object

baseAmount.bigNumericality​

bigNumericality: object

baseAmount.bigNumericality.greaterThanOrEqualTo​

greaterThanOrEqualTo: number

baseAmount.bigNumericality.lessThanOrEqualTo​

lessThanOrEqualTo: any

baseAmount.bigNumericality.notGreaterThanOrEqualTo​

notGreaterThanOrEqualTo: string

baseAmount.bigNumericality.notLessThanOrEqualTo​

notLessThanOrEqualTo: string

price​

price: object

price.bigNumericality​

bigNumericality: object

price.bigNumericality.greaterThan​

greaterThan: number = 0

quoteAmount​

quoteAmount: object

quoteAmount.bigNumericality​

bigNumericality: object

quoteAmount.bigNumericality.greaterThanOrEqualTo​

greaterThanOrEqualTo: number

quoteAmount.bigNumericality.lessThanOrEqualTo​

lessThanOrEqualTo: any

quoteAmount.bigNumericality.notGreaterThanOrEqualTo​

notGreaterThanOrEqualTo: string

quoteAmount.bigNumericality.notLessThanOrEqualTo​

notLessThanOrEqualTo: string

Overrides​

BaseOrder.constraints


getOrders()​

getOrders(): BaseOrder[]

Defined in: orders/limit.ts:104

Returns​

BaseOrder[]

Overrides​

BaseOrder.getOrders


quoteFee()​

quoteFee(): BigNumber

Defined in: orders/limit.ts:90

Returns​

BigNumber


resetError()​

resetError(): void

Defined in: orders/base.ts:58

Returns​

void

Inherited from​

BaseOrder.resetError


startEdit()​

startEdit(orderExternalId): void

Defined in: orders/base.ts:51

Parameters​

orderExternalId​

string

Returns​

void

Inherited from​

BaseOrder.startEdit


updateBaseAmount()​

updateBaseAmount(baseAmount): void

Defined in: orders/limit.ts:73

Parameters​

baseAmount​

BigNumber

Returns​

void


updateLockedOn()​

updateLockedOn(lockedOn): void

Defined in: orders/limit.ts:85

Parameters​

lockedOn​

string

Returns​

void

Overrides​

BaseOrder.updateLockedOn


updatePrice()​

updatePrice(price): void

Defined in: orders/limit.ts:94

Parameters​

price​

BigNumber

Returns​

void


updateQuoteAmount()​

updateQuoteAmount(quoteAmount): void

Defined in: orders/limit.ts:79

Parameters​

quoteAmount​

BigNumber

Returns​

void


validate()​

validate(): boolean

Defined in: orders/base.ts:63

Returns​

boolean

Inherited from​

BaseOrder.validate