@globalleaderboards/sdk - v0.5.0
    Preparing search index...

    Interface GlobalLeaderboardsConfig

    Configuration options for the GlobalLeaderboards SDK

    interface GlobalLeaderboardsConfig {
        apiKey: string;
        defaultLeaderboardId?: string;
        baseUrl?: string;
        wsUrl?: string;
        timeout?: number;
        autoRetry?: boolean;
        maxRetries?: number;
    }
    Index

    Properties

    apiKey defaultLeaderboardId? baseUrl? wsUrl? timeout? autoRetry? maxRetries?

    Properties

    apiKey: string

    API key for authentication

    defaultLeaderboardId?: string

    Default leaderboard ID for simplified submit() calls

    baseUrl?: string

    Base URL for the API (default: https://api.globalleaderboards.net)

    wsUrl?: string

    WebSocket URL (default: wss://api.globalleaderboards.net)

    timeout?: number

    Request timeout in milliseconds (default: 30000)

    autoRetry?: boolean

    Enable automatic retry on failure (default: true)

    maxRetries?: number

    Maximum number of retry attempts (default: 3)

    Settings

    Member Visibility

    On This Page

    Properties