README.md

Docs

Examples

• Basic leaderboard usage
• Exporting a leaderboard
• Recurring leaderboards
• Custom cycles
• Clean stale leaderboards
• Matrix of leaderboards
• Showcasing leaderboards

API Reference

• Types
• Leaderboard
  • Types
  • Constructor
  • Insert/update entries
  • Remove entries
  • Find entries
  • List entries
  • Export
  • Information
• PeriodicLeaderboard
  • Types
  • Constructor
  • Keys
  • Leaderboards
• LeaderboardMatrix
  • Types
  • Constructor
  • Leaderboards
  • Insert/update entries
  • Remove entries
  • Find entries
  • List entries
  • Information
• Redis keys

Types

Most common types exposed by the API.

• ID: string
• Score: number
• Rank: number 1-based
• SortPolicy: 'high-to-low' | 'low-to-high'
• UpdatePolicy: 'replace' | 'aggregate' | 'best'

Redis keys

Patterns used for the Redis keys is the following:

• Leaderboard: <key>
• PeriodicLeaderboard: <baseKey>:<CycleKey>
• LeaderboardMatrix: <baseKey>:<dimension>:<feature> with :<CycleKey> if applies

To avoid overlaps or other issues, we recommend avoiding the use of : in base keys, dimension name, and feature name.