UNPKG

steamapi

Version:

A nice Steam API wrapper.

github.com/xDimGG/node-steamapi

xDimGG/node-steamapi

330 lines (165 loc) • 7.19 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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
[**steamapi**](../README.md) *** [steamapi](../README.md) / GameInfoExtended # Class: GameInfoExtended Defined in: [structures/GameInfoExtended.ts:3](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfoExtended.ts#L3) ## Extends - [`GameInfo`](GameInfo.md) ## Constructors ### Constructor > **new GameInfoExtended**(`data`): `GameInfoExtended` Defined in: [structures/GameInfoExtended.ts:19](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfoExtended.ts#L19) #### Parameters ##### data `any` #### Returns `GameInfoExtended` #### Overrides [`GameInfo`](GameInfo.md).[`constructor`](GameInfo.md#constructor) ## Properties ### capsuleFilename? > `optional` **capsuleFilename**: `string` Defined in: [structures/GameInfoExtended.ts:14](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfoExtended.ts#L14) Game's capsule filename. Not sure what this means *** ### descriptorIDs? > `optional` **descriptorIDs**: `number`[] Defined in: [structures/GameInfo.ts:11](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfo.ts#L11) Descriptor IDs. Not sure what this means. Usually undefined #### Inherited from [`GameInfo`](GameInfo.md).[`descriptorIDs`](GameInfo.md#descriptorids) *** ### hasCommunityVisibleStats > **hasCommunityVisibleStats**: `boolean` Defined in: [structures/GameInfo.ts:5](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfo.ts#L5) If this game has community visible stats #### Inherited from [`GameInfo`](GameInfo.md).[`hasCommunityVisibleStats`](GameInfo.md#hascommunityvisiblestats) *** ### hasDLC > **hasDLC**: `boolean` Defined in: [structures/GameInfoExtended.ts:11](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfoExtended.ts#L11) If this game has DLC *** ### hasLeaderboards > **hasLeaderboards**: `boolean` Defined in: [structures/GameInfo.ts:8](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfo.ts#L8) If this game has leaderboards #### Inherited from [`GameInfo`](GameInfo.md).[`hasLeaderboards`](GameInfo.md#hasleaderboards) *** ### hasMarket > **hasMarket**: `boolean` Defined in: [structures/GameInfoExtended.ts:8](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfoExtended.ts#L8) If this game has a market *** ### hasWorkshop > **hasWorkshop**: `boolean` Defined in: [structures/GameInfoExtended.ts:5](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfoExtended.ts#L5) If this game has a workshop *** ### icon > **icon**: `string` Defined in: [structures/GameInfoBasic.ts:10](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfoBasic.ts#L10) Hash for this game's icon #### Inherited from [`GameInfo`](GameInfo.md).[`icon`](GameInfo.md#icon) *** ### id > **id**: `number` Defined in: [structures/Game.ts:6](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L6) App ID for this game #### Inherited from [`GameInfo`](GameInfo.md).[`id`](GameInfo.md#id) *** ### name > **name**: `string` Defined in: [structures/GameInfoBasic.ts:7](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfoBasic.ts#L7) Name for this game #### Inherited from [`GameInfo`](GameInfo.md).[`name`](GameInfo.md#name) *** ### sortName? > `optional` **sortName**: `string` Defined in: [structures/GameInfoExtended.ts:17](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfoExtended.ts#L17) Name that this game is sorted by ## Accessors ### backgroundURL #### Get Signature > **get** **backgroundURL**(): `string` Defined in: [structures/Game.ts:28](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L28) (might not exist) game page background ##### Returns `string` #### Inherited from [`GameInfo`](GameInfo.md).[`backgroundURL`](GameInfo.md#backgroundurl) *** ### coverURL #### Get Signature > **get** **coverURL**(): `string` Defined in: [structures/Game.ts:31](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L31) (might not exist) game cover ##### Returns `string` #### Inherited from [`GameInfo`](GameInfo.md).[`coverURL`](GameInfo.md#coverurl) *** ### headerMediumURL #### Get Signature > **get** **headerMediumURL**(): `string` Defined in: [structures/Game.ts:16](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L16) (might not exist) medium sized header image ##### Returns `string` #### Inherited from [`GameInfo`](GameInfo.md).[`headerMediumURL`](GameInfo.md#headermediumurl) *** ### headerURL #### Get Signature > **get** **headerURL**(): `string` Defined in: [structures/Game.ts:13](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L13) (might not exist) large sized header used on the store page ##### Returns `string` #### Inherited from [`GameInfo`](GameInfo.md).[`headerURL`](GameInfo.md#headerurl) *** ### iconURL #### Get Signature > **get** **iconURL**(): `string` Defined in: [structures/GameInfoBasic.ts:20](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfoBasic.ts#L20) tiny app icon ##### Returns `string` #### Inherited from [`GameInfo`](GameInfo.md).[`iconURL`](GameInfo.md#iconurl) *** ### logoURL #### Get Signature > **get** **logoURL**(): `string` Defined in: [structures/Game.ts:34](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L34) (might not exist) transparent game logo ##### Returns `string` #### Inherited from [`GameInfo`](GameInfo.md).[`logoURL`](GameInfo.md#logourl) *** ### smallHeaderURL #### Get Signature > **get** **smallHeaderURL**(): `string` Defined in: [structures/Game.ts:19](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L19) (might not exist) small header image used on user pages ##### Returns `string` #### Inherited from [`GameInfo`](GameInfo.md).[`smallHeaderURL`](GameInfo.md#smallheaderurl) *** ### tinyHeaderURL #### Get Signature > **get** **tinyHeaderURL**(): `string` Defined in: [structures/Game.ts:22](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L22) (might not exist) tiny header image used on app bundles ##### Returns `string` #### Inherited from [`GameInfo`](GameInfo.md).[`tinyHeaderURL`](GameInfo.md#tinyheaderurl)