uefa-api/dist/helpers/players.d.ts

Typescript bindings and utils for the UEFA APIs

import type { Player } from '../api';
interface FilterCriteria {
    competitionId?: string | number;
    playerIds?: string | number | (string | number)[];
    seasonYear?: string | number;
}
/**
 * Get player details based on filter criteria
 * The API response is paginated by a limit and offset, except when filtering by player ids
 *
 * @param filter The criteria to filter players by (competition id, player ids, season year)
 * @param limit Maximum number of players to return
 * @param offset Number of players to skip
 * @returns Promise resolving to an array of players
 */
export declare const getPlayers: (filter: FilterCriteria, limit?: number, offset?: number) => Promise<Player[]>;
export {};