Interface OrderEngineOptions

interface OrderEngineOptions {
    armed?: boolean;
    constraints: OrderConstraints;
    feed: OrderFeed;
    gate?: GateFn;
    idGen?: () => string;
    minModifyIntervalMs?: number;
    mode?: TradeMode;
    now?: () => number;
    onValidationError?: (reason: string) => void;
}

Index

Properties

armed? constraints feed gate? idGen? minModifyIntervalMs? mode? now? onValidationError?

Properties

`Optional`armed

armed?: boolean

Armed = fire immediately; otherwise the gate must approve each order.

constraints

constraints: OrderConstraints

feed

feed: OrderFeed

`Optional`gate

gate?: GateFn

`Optional`idGen

idGen?: () => string

`Optional`minModifyIntervalMs

minModifyIntervalMs?: number

`Optional`mode

mode?: TradeMode

`Optional`now

now?: () => number

`Optional`onValidationError

onValidationError?: (reason: string) => void

Called when a drag-modify price fails validation (so the UI can snap back).