Function getBadgesList

  • Returns a list of all badges.

    Filter options

    • gameId - filters by ID of the Steam game the badge belongs to,
    • title - filters by title of the non-Steam game the badge belongs to,
    • isSteamGame - filters by game being on Steam or not,
    • isLegacy - filters by badge's legacy status,
    • isEnabled - filters by badge's enabled status.

    Sort options

    • points - sorts by badge's point value.

    Usage

    const badgesAll: Badge[] = await sdk.getBadgesList({ });
    const badgePointsAsc: Badge[] = await sdk.getBadgesList({ sort: { points: 'asc' }});
    const badgesSteamGames: Badge[] = await sdk.getBadgesList({ filter: { isSteamGame: true }});

    Parameters

    Returns Promise<Badge[]>

Generated using TypeDoc