forked from pjanik4/Stockrender-Template-Client-side-app
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Doc.txt
43 lines (30 loc) · 1.06 KB
/
Doc.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
Doc
----------------------------------------------------------------------------
StockRender.AppRender.register(obj) :: Registers you application with the framework
obj =
id: String || Number,
name: String,
version: String || Number,
defaults: {
terminal: {
x: Number,
y: Number,
w: Number,
h: Number
}
},
beforeRender: function () {},
ready: function(AppMemory, AppData, appIns) {}
----------------------------------------------------------------------------
AppMemory :: Module that handles User Data and instance memory
[1] AppMemory.read(request_value) :: Reads a property of the current user for this application.
returns
{success(data),error(err, data)}
----------------------------------------------------------------------------
AppData :: Module that handles various stock data
[1] AppData.v1.fundamental.GET(stockId, fundamentals_type) :: handler for financial historical value of the stock
returns
{Promise}
[2] AppData.v1.pricedata.GET(stockId) :: handler for historical price-data of a stock
returns
{Promise}