Interface IHistoryService

Service for interacting with the history of matches.

interface IHistoryService {
find(criteria?: HistorySearchCriteria, cursor?: string, count?: number): Promise<HistorySearchResults>;
get(matchId: string): Promise<HistoryItem>;
}

Index

Methods

Methods

find

find(criteria?, cursor?, count?): Promise<HistorySearchResults>
Retrieves a list of matches with the given search criteria.
Parameters
- Optionalcriteria: HistorySearchCriteria
  Search criteria.
- Optionalcursor: string
  Cursor for pagination. If not provided, starts from the beginning.
- Optionalcount: number
  Number of items to return. If not provided, returns all items. Maxes out at 100.
Returns Promise<HistorySearchResults>
A tuple of the next pagination cursor and the list of matches.
- Defined in src/core/history/interfaces.ts:17

get

get(matchId): Promise<HistoryItem>
Retrieves a specific match by its ID.
Parameters
- matchId: string
  ID of the match.
Returns Promise<HistoryItem>
The match.
- Defined in src/core/history/interfaces.ts:30