Interface ApiConfig

Configuration options for creating an ApiClient.

interface ApiConfig {
    authProvider: AuthProvider;
    fetchOptions?: DonationAlertsCallFetchOptions;
    logger?: Partial<LoggerOptions>;
    rateLimiterOptions?: RateLimiterOptions;
}

Properties

authProvider fetchOptions? logger? rateLimiterOptions?

Properties

authProvider

authProvider: AuthProvider

The authentication provider responsible for supplying access tokens to the client.

Remarks

The client uses this provider to authorize requests to the Donation Alerts API. For more details, refer to the AuthProvider documentation.

OptionalfetchOptions

fetchOptions?: DonationAlertsCallFetchOptions

Custom options to pass to the fetch method used for API requests.

Optionallogger

logger?: Partial<LoggerOptions>

Configuration options for logging within the client.

OptionalrateLimiterOptions

rateLimiterOptions?: RateLimiterOptions

Settings for the rate limiter that controls the request rate to the API.

Settings

Member Visibility

On This Page

Properties