documentation

This commit is contained in:
Olivier Gagnon
2021-10-30 16:03:34 -04:00
parent 01dcf3c64f
commit 9b0726ca9a
25 changed files with 236 additions and 280 deletions
+2 -27
View File
@@ -10,34 +10,9 @@ import { PositionTypes } from "../StockMarket/data/PositionTypes";
import { StockSymbols } from "../StockMarket/data/StockSymbols";
import { getStockMarket4SDataCost, getStockMarket4STixApiCost } from "../StockMarket/StockMarketCosts";
import { Stock } from "../StockMarket/Stock";
import { TIX } from "../ScriptEditor/NetscriptDefinitions";
export interface INetscriptStockMarket {
getSymbols(): any;
getPrice(symbol: any): any;
getAskPrice(symbol: any): any;
getBidPrice(symbol: any): any;
getPosition(symbol: any): any;
getMaxShares(symbol: any): any;
getPurchaseCost(symbol: any, shares: any, posType: any): any;
getSaleGain(symbol: any, shares: any, posType: any): any;
buy(symbol: any, shares: any): any;
sell(symbol: any, shares: any): any;
short(symbol: any, shares: any): any;
sellShort(symbol: any, shares: any): any;
placeOrder(symbol: any, shares: any, price: any, type: any, pos: any): any;
cancelOrder(symbol: any, shares: any, price: any, type: any, pos: any): any;
getOrders(): any;
getVolatility(symbol: any): any;
getForecast(symbol: any): any;
purchase4SMarketData(): void;
purchase4SMarketDataTixApi(): void;
}
export function NetscriptStockMarket(
player: IPlayer,
workerScript: WorkerScript,
helper: INetscriptHelper,
): INetscriptStockMarket {
export function NetscriptStockMarket(player: IPlayer, workerScript: WorkerScript, helper: INetscriptHelper): TIX {
/**
* Checks if the player has TIX API access. Throws an error if the player does not
*/