Skip to content

Commit

Permalink
chore(getUserSummary): update docs on recent games count default value (
Browse files Browse the repository at this point in the history
  • Loading branch information
wescopeland authored Dec 8, 2023
1 parent 5d72a79 commit fee08c1
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/v1/users/get-user-summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ const userSummary = await getUserSummary(authorization, {
| :------------------------ | :------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------- |
| `authorization` | [`AuthObject`](/v1/data-models/auth-object) | An object that must contain a `userName` and a `webApiKey`. See [this page](/getting-started) for how to create this object. |
| `userName` | `string` | The user for which to retrieve the summary for. |
| `recentGamesCount` | `number?` | Optional. How many recent games to fetch. The default is 5. |
| `recentGamesCount` | `number?` | Optional. How many recent games to fetch. The default is 0. |
| `recentAchievementsCount` | `number?` | Optional. How many recent achievements to fetch. The default is 5. |

## Source
Expand Down
2 changes: 1 addition & 1 deletion src/user/getUserSummary.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import type { GetUserSummaryResponse, UserSummary } from "./models";
* @param payload.userName The user for which to retrieve the summary for.
*
* @param payload.recentGamesCount Optional. The number of recent games to return.
* This defaults to 5.
* This defaults to 0.
*
* @param payload.recentAchievementsCount Optional. The number of recent achievements
* to return. This defaults to 5.
Expand Down

0 comments on commit fee08c1

Please sign in to comment.