Class GearService

Service for gear and equipment management

Index

Constructors

Methods

calc create createReminder delete deleteReminder downloadCSV list replace update updateReminder

Constructors

constructor

new GearService(httpClient: IHttpClient, defaultAthleteId: string): GearService
Parameters
- httpClient: IHttpClient
- defaultAthleteId: string
Returns GearService
- Defined in services/gear.service.ts:8

Methods

calc

calc(gearId: string, athleteId?: string): Promise<GearStats>
Recalculate distance / time / activity totals for one item of gear
Parameters
- gearId: string
- OptionalathleteId: string
Returns Promise<GearStats>
- Defined in services/gear.service.ts:70

create

create(data: Partial<Gear>, athleteId?: string): Promise<Gear>
Create a new gear item
Parameters
- data: Partial<Gear>
- OptionalathleteId: string
Returns Promise<Gear>
- Defined in services/gear.service.ts:14

createReminder

createReminder(
    gearId: string,
    data: Partial<GearReminder>,
    athleteId?: string,
): Promise<GearReminder>
Create a gear reminder
Parameters
- gearId: string
- data: Partial<GearReminder>
- OptionalathleteId: string
Returns Promise<GearReminder>
- Defined in services/gear.service.ts:38

delete

delete(gearId: string, athleteId?: string): Promise<void>
Delete a gear item
Parameters
- gearId: string
- OptionalathleteId: string
Returns Promise<void>
- Defined in services/gear.service.ts:26

deleteReminder

deleteReminder(
    gearId: string,
    reminderId: number,
    athleteId?: string,
): Promise<void>
Delete a gear reminder
Parameters
- gearId: string
- reminderId: number
- OptionalathleteId: string
Returns Promise<void>
- Defined in services/gear.service.ts:50

downloadCSV

downloadCSV(athleteId?: string): Promise<Buffer<ArrayBufferLike>>
All of the athlete's gear as CSV
Parameters
- OptionalathleteId: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in services/gear.service.ts:64

list

list(athleteId?: string): Promise<Gear[]>
All of the athlete's gear
Parameters
- OptionalathleteId: string
Returns Promise<Gear[]>
- Defined in services/gear.service.ts:58

replace

replace(
    gearId: string,
    data: { new_gear_id: string },
    athleteId?: string,
): Promise<void>
Replace a gear item (transfer activities to a new gear item)
Parameters
- gearId: string
- data: { new_gear_id: string }
- OptionalathleteId: string
Returns Promise<void>
- Defined in services/gear.service.ts:32

update

update(gearId: string, data: Partial<Gear>, athleteId?: string): Promise<Gear>
Update a gear item
Parameters
- gearId: string
- data: Partial<Gear>
- OptionalathleteId: string
Returns Promise<Gear>
- Defined in services/gear.service.ts:20

updateReminder

updateReminder(
    gearId: string,
    reminderId: number,
    data: Partial<GearReminder>,
    athleteId?: string,
): Promise<GearReminder>
Update a gear reminder
Parameters
- gearId: string
- reminderId: number
- data: Partial<GearReminder>
- OptionalathleteId: string
Returns Promise<GearReminder>
- Defined in services/gear.service.ts:44