Class Boxrec

Hierarchy

Boxrec

Methods

Static getBoutById

getBoutById(cookies: string, eventBoutId: string): Promise<BoxrecPageEventBout>

- Defined in boxrec.class.ts:62
Parameters
- cookies: string
- eventBoutId: string
Returns Promise<BoxrecPageEventBout>

Static getBoxerPDF

getBoxerPDF(cookies: string, globalId: number, pathToSaveTo: undefined | string, fileName: undefined | string): Promise<string>

- Defined in boxrec.class.ts:76
Parameters
- cookies: string
- globalId: number
- Optional pathToSaveTo: undefined | string
- Optional fileName: undefined | string
Returns Promise<string>

Static getBoxerPrint

getBoxerPrint(cookies: string, globalId: number, pathToSaveTo: undefined | string, fileName: undefined | string): Promise<string>

- Defined in boxrec.class.ts:88
Parameters
- cookies: string
- globalId: number
- Optional pathToSaveTo: undefined | string
- Optional fileName: undefined | string
Returns Promise<string>

Static getChampions

getChampions(cookies: string): Promise<BoxrecPageChampions>

- Defined in boxrec.class.ts:97
Parameters
- cookies: string
Returns Promise<BoxrecPageChampions>

Static getDate

getDate(cookies: string, params: BoxrecDate): Promise<BoxrecPageDate>

- Defined in boxrec.class.ts:109
Parameters
- cookies: string
- params: BoxrecDate
Returns Promise<BoxrecPageDate>

Static getEventById

getEventById(cookies: string, eventId: number): Promise<BoxrecPageEvent>

- Defined in boxrec.class.ts:121
Parameters
- cookies: string
- eventId: number
Returns Promise<BoxrecPageEvent>

Static getEventsByLocation

getEventsByLocation(cookies: string, params: BoxrecLocationEventParams, offset?: number): Promise<BoxrecPageLocationEvent>

- Defined in boxrec.class.ts:135
Parameters
- cookies: string
- params: BoxrecLocationEventParams
- Default value offset: number = 0
Returns Promise<BoxrecPageLocationEvent>

Static getPeopleByLocation

getPeopleByLocation(cookies: string, params: BoxrecLocationsPeopleParams, offset?: number): Promise<BoxrecPageLocationPeople | BoxrecPageLocationBoxer>

- Defined in boxrec.class.ts:149
Parameters
- cookies: string
- params: BoxrecLocationsPeopleParams
- Default value offset: number = 0
Returns Promise<BoxrecPageLocationPeople | BoxrecPageLocationBoxer>

Static getPeopleByName

getPeopleByName(cookies: string, firstName: string, lastName: string, role?: BoxrecRole, status?: BoxrecStatus, offset?: number): AsyncIterableIterator<BoxrecPageProfileBoxer | BoxrecPageProfileOtherCommon | BoxrecPageProfileEvents | BoxrecPageProfileManager>

- Defined in boxrec.class.ts:359
Parameters
- cookies: string
- firstName: string
- lastName: string
- Default value role: BoxrecRole = BoxrecRole.proBoxer
- Default value status: BoxrecStatus = BoxrecStatus.all
- Default value offset: number = 0
Returns AsyncIterableIterator<BoxrecPageProfileBoxer | BoxrecPageProfileOtherCommon | BoxrecPageProfileEvents | BoxrecPageProfileManager>

Static getPersonById

getPersonById(cookies: string, globalId: number, role?: BoxrecRole | null, offset?: number): Promise<BoxrecPageProfileBoxer | BoxrecPageProfileOtherCommon | BoxrecPageProfileEvents | BoxrecPageProfileManager | BoxrecPageProfilePromoter>

- Defined in boxrec.class.ts:170
Parameters
- cookies: string
- globalId: number
- Default value role: BoxrecRole | null = null
- Default value offset: number = 0
Returns Promise<BoxrecPageProfileBoxer | BoxrecPageProfileOtherCommon | BoxrecPageProfileEvents | BoxrecPageProfileManager | BoxrecPageProfilePromoter>

Static getRatings

getRatings(cookies: string, params: BoxrecRatingsParams, offset?: number): Promise<BoxrecPageRatings>

- Defined in boxrec.class.ts:211
Parameters
- cookies: string
- params: BoxrecRatingsParams
- Default value offset: number = 0
Returns Promise<BoxrecPageRatings>

Static getResults

getResults(cookies: string, params: BoxrecResultsParams, offset?: number): Promise<BoxrecPageSchedule>

- Defined in boxrec.class.ts:226
Parameters
- cookies: string
- params: BoxrecResultsParams
- Default value offset: number = 0
Returns Promise<BoxrecPageSchedule>

Static getSchedule

getSchedule(cookies: string, params: BoxrecScheduleParams, offset?: number): Promise<BoxrecPageSchedule>

- Defined in boxrec.class.ts:240
Parameters
- cookies: string
- params: BoxrecScheduleParams
- Default value offset: number = 0
Returns Promise<BoxrecPageSchedule>

Static getTitleById

getTitleById(cookies: string, titleString: string, offset?: number): Promise<BoxrecPageTitle>

- Defined in boxrec.class.ts:254
Parameters
- cookies: string
- titleString: string
- Default value offset: number = 0
Returns Promise<BoxrecPageTitle>

Static getTitles

getTitles(cookies: string, params: BoxrecTitlesParams, offset?: number): Promise<any>

- Defined in boxrec.class.ts:268
Parameters
- cookies: string
- params: BoxrecTitlesParams
- Default value offset: number = 0
Returns Promise<any>

Static getVenueById

getVenueById(cookies: string, venueId: number, offset?: number): Promise<BoxrecPageVenue>

- Defined in boxrec.class.ts:281
Parameters
- cookies: string
- venueId: number
- Default value offset: number = 0
Returns Promise<BoxrecPageVenue>

Static getWatched

getWatched(cookies: string): Promise<BoxrecPageWatchRow[]>

- Defined in boxrec.class.ts:293
Parameters
- cookies: string
Returns Promise<BoxrecPageWatchRow[]>

Static login

login(username: string, password: string): Promise<string>

- Defined in boxrec.class.ts:52
Parameters
- username: string
- password: string
Returns Promise<string>

the BoxRec log in cookie to make subsequent requests

Static search

search(cookies: string, params: BoxrecSearchParams, offset?: number): Promise<BoxrecSearch[]>

- Defined in boxrec.class.ts:307
Parameters
- cookies: string
- params: BoxrecSearchParams
- Default value offset: number = 0
Returns Promise<BoxrecSearch[]>

Static unwatch

unwatch(cookies: string, boxerGlobalId: number): Promise<boolean>

- Defined in boxrec.class.ts:319
Parameters
- cookies: string
- boxerGlobalId: number
Returns Promise<boolean>

Static watch

watch(cookies: string, boxerGlobalId: number): Promise<boolean>

- Defined in boxrec.class.ts:336
Parameters
- cookies: string
- boxerGlobalId: number
Returns Promise<boolean>

Generated using TypeDoc