iracing-api/lib/api/team.d.ts

Javascript client for iracing API

import { API } from './api';
import { GetTeamDataParams, GetTeamDataResponse } from '../types';
/**
 * Provides methods for interacting with team-related endpoints.
 */
export declare class TeamAPI extends API {
    /**
     * Get detailed information about a specific team.
     *
     * @param {GetTeamDataParams} params - Parameters for the request.
     * @param {number} params.teamId - The ID of the team to retrieve.
     * @param {boolean} [params.includeLicenses=false] - Include license information for members (can slow down response).
     *
     * @returns A promise resolving to the team data, or undefined on error.
     */
    getTeamData: (params: GetTeamDataParams) => Promise<GetTeamDataResponse | undefined>;
}