iracing-api
Version:
Javascript client for iracing API
34 lines (33 loc) • 1.04 kB
TypeScript
import { API } from './api';
/**
* Provides methods for retrieving constant data like categories, divisions, and event types.
*/
export declare class ConstantsAPI extends API {
/**
* Get the list of iRacing racing categories (e.g., Oval, Road).
*
* @returns A promise resolving to an array of category objects, or undefined on error.
*/
getCategories: () => Promise<{
value: number;
label: string;
}[] | undefined>;
/**
* Get the list of iRacing divisions (e.g., Division 1, Rookie).
*
* @returns A promise resolving to an array of division objects, or undefined on error.
*/
getDivisions: () => Promise<{
value: number;
label: string;
}[] | undefined>;
/**
* Get the list of iRacing event types (e.g., Practice, Race).
*
* @returns A promise resolving to an array of event type objects, or undefined on error.
*/
getEventTypes: () => Promise<{
value: number;
label: string;
}[] | undefined>;
}