UNPKG

@theedeer0/battlemetrics-api

Version:

An object-oriented BattleMetrics API wrapper for Node.js developers with TypeScript support.

github.com/TheeDeer0/BattleMetrics-API

TheeDeer0/BattleMetrics-API

106 lines (57 loc) • 2.05 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
[@theedeer/battlemetrics](../README.md) / export= # Class: export= ## Table of contents ### Constructors - [constructor](export_.md#constructor) ### Properties - [axios](export_.md#axios) ### Methods - [findPlayersByQuickMatch](export_.md#findplayersbyquickmatch) - [getPlayerById](export_.md#getplayerbyid) ## Constructors ### constructor • **new export=**(`token`): [`export=`](export_.md) #### Parameters | Name | Type | | :------ | :------ | | `token` | `string` | #### Returns [`export=`](export_.md) #### Defined in src/BattleMetrics.ts:16 ## Properties ### axios • `Private` **axios**: `any` #### Defined in src/BattleMetrics.ts:15 ## Methods ### findPlayersByQuickMatch ▸ **findPlayersByQuickMatch**(`options`): `Promise`\<`Player`[]\> Fetches players from the BattleMetrics API using the quick match feature. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `options` | `QuickMatchOptions` | The options for the quick match feature. This should be an object that conforms to the QuickMatchOptions interface, which includes the type of identifier and the identifier itself. | #### Returns `Promise`\<`Player`[]\> A Promise that resolves to an array of Player objects. **`Throws`** Will throw an error if the request fails. #### Defined in src/BattleMetrics.ts:51 ___ ### getPlayerById ▸ **getPlayerById**(`id`, `include?`): `Promise`\<`Player`\> Fetches a player's data from the BattleMetrics API by their BM ID. #### Parameters | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | | `id` | `string` | `undefined` | The Battlemetrics ID of the player to fetch. | | `include?` | `PlayerIncludeOptions`[] | `[]` | An array of strings specifying additional resources to include in the API response. Valid options are "servers" and "identifiers". | #### Returns `Promise`\<`Player`\> A Promise that resolves to the Player object. **`Throws`** Will throw an error if the request fails. #### Defined in src/BattleMetrics.ts:32