Skip to content

Commit a4aa144

Browse files
committed
Update CHANGELOG and README for 0.4.0
1 parent 94de419 commit a4aa144

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66

77
---
88

9-
### [0.4.0] (unreleased)
9+
### [0.4.0] (2021-06-22)
1010

1111
#### Added
1212

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ const galeforce = new GaleforceModule(/* config */);
6565
```javascript
6666
const summoners = ['a', 'b', 'c'];
6767
const promises = summoners.map(summoner => galeforce.lol.summoner()
68-
.region(galeforce.regions.lol.NORTH_AMERICA)
68+
.region(galeforce.region.lol.NORTH_AMERICA)
6969
.name(summoner)
7070
.exec()
7171
); // list of request promises
@@ -81,7 +81,7 @@ Promise.all(promises).then((result) => {
8181

8282
```javascript
8383
const matchIds = (await galeforce.lol.match.list()
84-
.region(galeforce.regions.lol.NORTH_AMERICA)
84+
.region(galeforce.region.lol.NORTH_AMERICA)
8585
.accountId(accountId)
8686
.exec())
8787
.matches.map(matchInfo => matchInfo.gameId);
@@ -94,7 +94,7 @@ const matchIds = (await galeforce.lol.match.list()
9494

9595
```javascript
9696
const matchData = await galeforce.lol.match.match()
97-
.region(galeforce.regions.lol.NORTH_AMERICA)
97+
.region(galeforce.region.lol.NORTH_AMERICA)
9898
.matchId(matchId)
9999
.exec();
100100
```
@@ -106,7 +106,7 @@ const matchData = await galeforce.lol.match.match()
106106

107107
```javascript
108108
const totalMasteryPoints = (await galeforce.lol.mastery.list()
109-
.region(galeforce.regions.lol.NORTH_AMERICA)
109+
.region(galeforce.region.lol.NORTH_AMERICA)
110110
.summonerId(summonerId)
111111
.exec())
112112
.reduce((previous, current) => previous + current.championPoints, 0);
@@ -132,7 +132,7 @@ Each endpoint in the Galeforce library is an instance of an `Action` containing
132132
> ```javascript
133133
> /* Gets Valorant platform and status data. */
134134
> galeforce.val.status() // Target the /val/status/v1/platform-data endpoint
135-
> .region(galeforce.regions.val.NORTH_AMERICA) // See below for documentation.
135+
> .region(galeforce.region.val.NORTH_AMERICA) // See below for documentation.
136136
> .exec() // Sends a Valorant server status request to the val-status-v1 endpoint
137137
> .then((data) => { // Use the returned data
138138
> /* manipulate status data */
@@ -150,9 +150,9 @@ Each endpoint in the Galeforce library is an instance of an `Action` containing
150150
>
151151
> ```javascript
152152
> /* Gets the Data Dragon URL associated with the Galeforce icon. */
153-
> const galeforceURL = galeforce.ddragon.item.art() // Fetch item icon art from Data Dragon
153+
> const galeforceURL = galeforce.lol.ddragon.item.art() // Fetch item icon art from Data Dragon
154154
> .version('11.9.1') // See the .<property>() section for documentation. Sets the version to retrieve data from.
155-
> .assetId('6671') // See below for documentation. Get the icon for the Galeforce item.
155+
> .assetId(6671) // See below for documentation. Get the icon for the Galeforce item.
156156
> .URL(); // Get the encoded URL corresponding with the selected endpoint as a string.
157157
>
158158
> console.log(galeforceURL); // 'https://ddragon.leagueoflegends.com/cdn/11.9.1/img/item/6671.png'
@@ -170,7 +170,7 @@ Each endpoint in the Galeforce library is an instance of an `Action` containing
170170
> ```javascript
171171
> /* Gets current game info for a specific summonerId. */
172172
> const currentGameInfo = await galeforce.lol.spectator.active() // Target the /lol/spectator/v4/active-games/by-summoner/{summonerId} endpoint
173-
> .region(galeforce.regions.lol.NORTH_AMERICA) // Sets the request region to 'na1' (i.e., target the NA server)
173+
> .region(galeforce.region.lol.NORTH_AMERICA) // Sets the request region to 'na1' (i.e., target the NA server)
174174
> .summonerId('summonerId') // Sets the request summonerId to 'summonerId'
175175
> .exec(); // See .exec() above.
176176
> ```
@@ -180,8 +180,8 @@ Each endpoint in the Galeforce library is an instance of an `Action` containing
180180
> ```javascript
181181
> /* Gets current game info for a specific summonerId. */
182182
> const currentGameInfo = await galeforce.lol.spectator.active() // Target the /lol/spectator/v4/active-games/by-summoner/{summonerId} endpoint
183-
> .region(galeforce.regions.lol.NORTH_AMERICA) // Sets the request region to 'na1' (i.e., target the NA server)
184-
> .region(galeforce.regions.lol.KOREA) // galeforce.lol.spectator.active(...).region(...).region is not a function
183+
> .region(galeforce.region.lol.NORTH_AMERICA) // Sets the request region to 'na1' (i.e., target the NA server)
184+
> .region(galeforce.region.lol.KOREA) // galeforce.lol.spectator.active(...).region(...).region is not a function
185185
> ```
186186
>
187187
</details>
@@ -197,9 +197,9 @@ Each endpoint in the Galeforce library is an instance of an `Action` containing
197197
> /* Gets league entries for a given Teamfight Tactics ranked league. */
198198
> const TFTLeagueInfo = await galeforce.tft.league.entries() // Target the /tft/league/v1/entries/{tier}/{division} endpoint
199199
> .set({ // Set multiple Action payload properties simultaneously
200-
> region: galeforce.regions.lol.NORTH_AMERICA, // Sets the request region to 'na1' (i.e., target the NA server)
201-
> tier: galeforce.tiers.DIAMOND, // Sets the request tier to 'DIAMOND' (i.e., search for players in Diamond)
202-
> division: galeforce.divisions.IV, // Sets the request division to 'IV' (i.e., search for players in division IV of their tier)
200+
> region: galeforce.region.lol.NORTH_AMERICA, // Sets the request region to 'na1' (i.e., target the NA server)
201+
> tier: galeforce.tier.DIAMOND, // Sets the request tier to 'DIAMOND' (i.e., search for players in Diamond)
202+
> division: galeforce.division.IV, // Sets the request division to 'IV' (i.e., search for players in division IV of their tier)
203203
> })
204204
> .exec(); // See .exec() above.
205205
> ```

0 commit comments

Comments
 (0)