@tradecanvas/commons 1.48.0 → 1.49.0

package/dist/market/types.d.ts

@@ -10,7 +10,9 @@ export interface MarketConfig {
     exchange?: StockExchange;
     currency?: string;
     pricePrecision?: number;
+    /** The board lot (100 shares on HOSE): the widget's order ticket asks for whole lots above one. */
     volumeUnit?: number;
+    /** The smallest price move, and the step below the first of `priceSteps`. */
     priceStep?: number;
     /**
      * Steps that depend on the price, lowest band first (HOSE: 10, 50 or 100
@@ -21,18 +23,26 @@ export interface MarketConfig {
     timeZone?: string;
     /** Currency per point of a futures contract (VN30F: 100,000 dong). */
     contractMultiplier?: number;
+    /** The day's ceiling and floor, a percentage either side of the reference price. */
     priceLimits?: {
         enabled: boolean;
+        /** How far above the reference price the ceiling is, % (7 on HOSE). */
         ceilingPercent?: number;
+        /** How far below the reference price the floor is, % (7 on HOSE). */
         floorPercent?: number;
+        /** The price the limits are counted from, the last session's close; `chart.setPriceLimits(price)` sets it. */
         referencePrice?: number;
     };
+    /** The day's sessions, their times in the exchange's `timeZone`. */
     sessions?: TradingSession[];
+    /** The colours of rising, falling and unchanged prices, and of the ceiling, floor and reference price. */
     colorScheme?: MarketColorScheme;
 }
 export interface TradingSession {
     name: string;
+    /** When it starts, `'HH:mm'` (`'09:00'`), in the zone `getCurrentSession` is given: the market's `timeZone`. */
     startTime: string;
+    /** When it ends, `'HH:mm'` (`'11:30'`): the first minute no longer in it. */
     endTime: string;
     /** `preOpen` / `preClose`: the opening and closing auctions; `postClose`: trading after the close. */
     type: 'preOpen' | 'continuous' | 'preClose' | 'postClose' | 'closed';

package/dist/market/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/market/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC;AAElE,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;AAElF,uEAAuE;AACvE,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,SAAS,aAAa,EAAE,CAAC;IACtC,qEAAqE;IACrE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sEAAsE;IACtE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAG5B,WAAW,CAAC,EAAE;QACZ,OAAO,EAAE,OAAO,CAAC;QACjB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,CAAC;IAGF,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;IAG5B,WAAW,CAAC,EAAE,iBAAiB,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,sGAAsG;IACtG,IAAI,EAAE,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,GAAG,QAAQ,CAAC;CACtE;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,8CAA8C;AAC9C,MAAM,WAAW,aAAa;IAC5B,8DAA8D;IAC9D,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;CACxB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/market/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC;AAElE,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;AAElF,uEAAuE;AACvE,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mGAAmG;IACnG,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,6EAA6E;IAC7E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,SAAS,aAAa,EAAE,CAAC;IACtC,qEAAqE;IACrE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sEAAsE;IACtE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,oFAAoF;IACpF,WAAW,CAAC,EAAE;QACZ,OAAO,EAAE,OAAO,CAAC;QACjB,uEAAuE;QACvE,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,qEAAqE;QACrE,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,8GAA8G;QAC9G,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,CAAC;IAEF,oEAAoE;IACpE,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;IAE5B,0GAA0G;IAC1G,WAAW,CAAC,EAAE,iBAAiB,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,gHAAgH;IAChH,SAAS,EAAE,MAAM,CAAC;IAClB,6EAA6E;IAC7E,OAAO,EAAE,MAAM,CAAC;IAChB,sGAAsG;IACtG,IAAI,EAAE,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,GAAG,QAAQ,CAAC;CACtE;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,8CAA8C;AAC9C,MAAM,WAAW,aAAa;IAC5B,8DAA8D;IAC9D,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;CACxB"}