soundcloud-api-ts - v1.9.0
    Preparing search index...

    Interface SoundCloudClientConfig

    Configuration options for creating a SoundCloudClient instance.

    interface SoundCloudClientConfig {
        clientId: string;
        clientSecret: string;
        maxRetries?: number;
        onDebug?: (message: string) => void;
        onTokenRefresh?: (client: SoundCloudClient) => Promise<SoundCloudToken>;
        redirectUri?: string;
        retryBaseDelay?: number;
    }
    Index

    Properties

    clientId clientSecret maxRetries? onDebug? onTokenRefresh? redirectUri? retryBaseDelay?

    Properties

    clientId: string

    Your SoundCloud application's OAuth client ID

    clientSecret: string

    Your SoundCloud application's OAuth client secret

    maxRetries?: number

    Maximum number of retries on 429 (rate limit) and 5xx (server error) responses (default: 3)

    onDebug?: (message: string) => void

    Optional debug logger callback for retry attempts and other internal events

    onTokenRefresh?: (client: SoundCloudClient) => Promise<SoundCloudToken>

    Called automatically when a request returns 401 Unauthorized. Return new tokens to transparently retry the failed request.

    redirectUri?: string

    OAuth redirect URI registered with your SoundCloud application (required for user auth flows)

    retryBaseDelay?: number

    Base delay in milliseconds for exponential backoff between retries (default: 1000)

    Settings

    Member Visibility

    On This Page

    Properties