UNPKG

steamapi

Version:

A nice Steam API wrapper.

github.com/xDimGG/node-steamapi

xDimGG/node-steamapi

124 lines (62 loc) • 2.97 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
[**steamapi**](../README.md) *** [steamapi](../README.md) / UserBadge # Class: UserBadge Defined in: [structures/UserBadge.ts:1](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/UserBadge.ts#L1) ## Constructors ### Constructor > **new UserBadge**(`data`): `Badge` Defined in: [structures/UserBadge.ts:26](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/UserBadge.ts#L26) #### Parameters ##### data `any` #### Returns `Badge` ## Properties ### appID? > `optional` **appID**: `number` Defined in: [structures/UserBadge.ts:18](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/UserBadge.ts#L18) If this badge belongs to a game, this is the app ID of that game *** ### borderColor? > `optional` **borderColor**: `number` Defined in: [structures/UserBadge.ts:24](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/UserBadge.ts#L24) If this badge belongs to a game, this is the border color for the badge. (note: seems to always be 0) *** ### communityItemID? > `optional` **communityItemID**: `number` Defined in: [structures/UserBadge.ts:21](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/UserBadge.ts#L21) If this badge belongs to a game, this is the community item ID for the badge *** ### completedTimestamp > **completedTimestamp**: `number` Defined in: [structures/UserBadge.ts:9](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/UserBadge.ts#L9) UNIX Timestamp for when this badge was completed *** ### id > **id**: `number` Defined in: [structures/UserBadge.ts:3](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/UserBadge.ts#L3) This badge's ID *** ### level > **level**: `number` Defined in: [structures/UserBadge.ts:6](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/UserBadge.ts#L6) The user's level for this badge *** ### scarcity > **scarcity**: `number` Defined in: [structures/UserBadge.ts:15](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/UserBadge.ts#L15) How many have received this badge *** ### xp > **xp**: `number` Defined in: [structures/UserBadge.ts:12](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/UserBadge.ts#L12) The amount of XP gained towards this badge ## Accessors ### completedAt #### Get Signature > **get** **completedAt**(): `Date` Defined in: [structures/UserBadge.ts:40](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/UserBadge.ts#L40) Date when this badge was completed ##### Returns `Date`