Interface MetronClientOptions

interface MetronClientOptions {
    autoThrottle?: boolean;
    baseUrl?: string;
    maxRetries?: number;
    token: string;
    userAgent?: string;
}

Properties

autoThrottle?: boolean

Proactively pause before a request would exceed the tracked rate limit. Default true.

baseUrl?: string

Override for testing against a different host.

maxRetries?: number

Max retries on a 429 response before throwing MetronRateLimitError. Default 3.

token: string

Knox API token, generated from your account settings at metron.cloud.

userAgent?: string