UNPKG

esijs

Version:

A simple module for ESI.

github.com/0xf0xx0/esiJS

0xf0xx0/esiJS

61 lines (41 loc) • 1.64 kB
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<!-- Generated by documentation.js. Update this documentation by updating the source code. --> ### Table of Contents - [public][1] - [bids][2] - [Parameters][3] - [contracts][4] - [Parameters][5] - [items][6] - [Parameters][7] ## public ### bids Lists bids on a public auction contract. #### Parameters - `contractID` {number} The auction contract to get the bids of. - `pageNumber` (optional, default `1`) - `pageNum` {number} The page of bids to get. Defaults to `1`. Returns **[Promise][8]<[object][9]>** The bids on the auction. ### contracts Returns a paginated list of all public contracts in the given region. #### Parameters - `regionID` {number} The region to get the contracts from. - `pageNumber` (optional, default `1`) - `pageNum` {number} The page of contracts to get. Defaults to `1`. Returns **[Promise][8]<[object][9]>** A paginated list of all public contracts in the given region. ### items Lists items of a public contract. #### Parameters - `contractID` {number} The contract to get items from. - `pageNumber` (optional, default `1`) - `pageNum` {number} The page of contracts to get. Defaults to `1`. Returns **[Promise][8]<\[[number][10]]>** A array of items. [1]: #public [2]: #bids [3]: #parameters [4]: #contracts [5]: #parameters-1 [6]: #items [7]: #parameters-2 [8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise [9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object [10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number