From 8a93d4fcde1ec10730a6277b1ac806a0e1f43b6e Mon Sep 17 00:00:00 2001 From: Ronan-Yann Lorin Date: Sat, 9 Mar 2024 08:38:16 +0100 Subject: [PATCH] Order conditions documentation --- src/api/order/condition/execution-condition.ts | 10 +++++----- src/api/order/condition/margin-condition.ts | 6 +++--- src/api/order/condition/percent-change-condition.ts | 10 +++++----- src/api/order/condition/price-condition.ts | 10 +++++----- src/api/order/condition/time-condition.ts | 6 +++--- src/api/order/condition/volume-condition.ts | 10 +++++----- yarn.lock | 2 +- 7 files changed, 27 insertions(+), 27 deletions(-) diff --git a/src/api/order/condition/execution-condition.ts b/src/api/order/condition/execution-condition.ts index 67ec22c0..22b2c2c0 100644 --- a/src/api/order/condition/execution-condition.ts +++ b/src/api/order/condition/execution-condition.ts @@ -15,16 +15,16 @@ export class ExecutionCondition implements OrderCondition { /** * Create a [[ExecutionCondition]] object. * - * @param exchange Exchange where the symbol needs to be traded. - * @param secType Kind of instrument being monitored. - * @param symbol Instrument's symbol. - * @param conjunctionConnection Conjunction connection type. + * @param symbol When an execution on symbol + * @param exchange at exchange + * @param secType for this secType + * @param conjunctionConnection AND | OR next condition (will be ignored if no more conditions are added) */ constructor( public exchange: string, public secType: SecType, public symbol: string, - public conjunctionConnection: ConjunctionConnection + public conjunctionConnection: ConjunctionConnection, ) {} } diff --git a/src/api/order/condition/margin-condition.ts b/src/api/order/condition/margin-condition.ts index cbcc31c6..8f92cdb5 100644 --- a/src/api/order/condition/margin-condition.ts +++ b/src/api/order/condition/margin-condition.ts @@ -11,9 +11,9 @@ export class MarginCondition implements OperatorCondition { /** * Create a [[MarginCondition]] object. * - * @param percent TODO document - * @param isMore TODO document - * @param conjunctionConnection Conjunction connection type. + * @param isMore If margin is above/below + * @param percent given percent + * @param conjunctionConnection AND | OR next condition (will be ignored if no more conditions are added) */ constructor( public percent: number, diff --git a/src/api/order/condition/percent-change-condition.ts b/src/api/order/condition/percent-change-condition.ts index bb74975d..809b2181 100644 --- a/src/api/order/condition/percent-change-condition.ts +++ b/src/api/order/condition/percent-change-condition.ts @@ -11,11 +11,11 @@ export class PercentChangeCondition implements ContractCondition { /** * Create a [[PercentChangeCondition]] object. * - * @param percent TODO document - * @param conId The contract id. - * @param exchange The exchange code. - * @param isMore TODO document - * @param conjunctionConnection Conjunction connection type. + * @param isMore If there is a price percent change measured against last close price above or below... + * @param percent this amount... + * @param conId on this contract + * @param exchange when traded on this exchange... + * @param conjunctionConnection AND | OR next condition (will be ignored if no more conditions are added) */ constructor( public percent: number, diff --git a/src/api/order/condition/price-condition.ts b/src/api/order/condition/price-condition.ts index dc723cce..e69e2573 100644 --- a/src/api/order/condition/price-condition.ts +++ b/src/api/order/condition/price-condition.ts @@ -12,12 +12,12 @@ export class PriceCondition implements ContractCondition { /** * Create a [[PriceCondition]] object. * - * @param price TODO document + * @param conId When this contract... + * @param exchange traded on this exchange + * @param isMore has a price above/below + * @param price this quantity * @param triggerMethod TODO document - * @param conId The contract id. - * @param exchange The exchange code. - * @param isMore TODO document - * @param conjunctionConnection Conjunction connection type. + * @param conjunctionConnection AND | OR next condition (will be ignored if no more conditions are added) */ constructor( public price: number, diff --git a/src/api/order/condition/time-condition.ts b/src/api/order/condition/time-condition.ts index 0aa66276..76066a50 100644 --- a/src/api/order/condition/time-condition.ts +++ b/src/api/order/condition/time-condition.ts @@ -11,9 +11,9 @@ export class TimeCondition implements OperatorCondition { /** * Create a [[TimeCondition]] object. * - * @param time Time field used in conditional order logic. Valid format: YYYYMMDD HH:MM:SS. - * @param isMore TODO - * @param conjunctionConnection Conjunction connection type. + * @param isMore Before or after... + * @param time this time... (Valid format: "YYYYMMDD HH:MM:SS") + * @param conjunctionConnection AND | OR next condition (will be ignored if no more conditions are added) */ constructor( public time: string, diff --git a/src/api/order/condition/volume-condition.ts b/src/api/order/condition/volume-condition.ts index ef62f747..8a61b19a 100644 --- a/src/api/order/condition/volume-condition.ts +++ b/src/api/order/condition/volume-condition.ts @@ -11,11 +11,11 @@ export class VolumeCondition implements ContractCondition { /** * Create a [[PriceCondition]] object. * - * @param volume TODO document - * @param conId The contract id. - * @param exchange The exchange code. - * @param isMore TODO document - * @param conjunctionConnection Conjunction connection type. + * @param conId Whenever contract... + * @param exchange When traded at + * @param isMore reaches a volume higher/lower + * @param volume than this... + * @param conjunctionConnection AND | OR next condition (will be ignored if no more conditions are added) */ constructor( public volume: number, diff --git a/yarn.lock b/yarn.lock index 066e97b4..55d14fb9 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3208,7 +3208,7 @@ typedoc@^0.25.11: minimatch "^9.0.3" shiki "^0.14.7" -typescript@^5.2.2: +typescript@^5.4.2: version "5.4.2" resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.4.2.tgz#0ae9cebcfae970718474fe0da2c090cad6577372" integrity sha512-+2/g0Fds1ERlP6JsakQQDXjZdZMM+rqpamFZJEKh4kwTIn3iDkgKtby0CeNd5ATNZ4Ry1ax15TMx0W2V+miizQ==