Class SportsLib

Primary facade for importing activities and routes, exporting route files, and restoring Sports Lib's native JSON representation.

Index

Constructors

Methods

convertRoutesFromFitToGPX convertRoutesFromGPXToFit exportRoutesToFit exportRoutesToGPX importFromFit importFromGPX importFromJSON importFromSuunto importFromTCX importRoutesFromFit importRoutesFromGPX importRoutesFromJSON

Constructors

constructor

new SportsLib(): SportsLib
Returns SportsLib

Methods

`Static`convertRoutesFromFitToGPX

convertRoutesFromFitToGPX(
arrayBuffer: ArrayBuffer | Buffer<ArrayBuffer>,
options?: RouteParsingOptions,
): Promise<string>
Converts a FIT course file to a GPX route file.
Parameters
- arrayBuffer: ArrayBuffer | Buffer<ArrayBuffer>
- Optionaloptions: RouteParsingOptions
Returns Promise<string>
- Defined in src/index.ts:144

`Static`convertRoutesFromGPXToFit

convertRoutesFromGPXToFit(
    gpxString: string,
    domParser?: any,
    options?: RouteParsingOptions,
): Promise<ArrayBuffer>
Converts a GPX route file to a FIT course file.
Parameters
- gpxString: string
- OptionaldomParser: any
  custom DOMParser (case of NodeJs usage)
- Optionaloptions: RouteParsingOptions
Returns Promise<ArrayBuffer>
- Defined in src/index.ts:131

`Static`exportRoutesToFit

exportRoutesToFit(routeFile: RouteFileInterface): Promise<ArrayBuffer>
Exports a single first-class route as a FIT course file.
Parameters
- routeFile: RouteFileInterface
Returns Promise<ArrayBuffer>
- Defined in src/index.ts:121

`Static`exportRoutesToGPX

exportRoutesToGPX(routeFile: RouteFileInterface): Promise<string>
Exports first-class routes using GPX route format.
Parameters
- routeFile: RouteFileInterface
Returns Promise<string>
- Defined in src/index.ts:113

`Static`importFromFit

importFromFit(
arrayBuffer: ArrayBuffer | Buffer<ArrayBuffer>,
options?: ActivityParsingOptions,
): Promise<EventInterface>
Parses and returns an event using FIT format
Parameters
- arrayBuffer: ArrayBuffer | Buffer<ArrayBuffer>
- Optionaloptions: ActivityParsingOptions
Returns Promise<EventInterface>
- Defined in src/index.ts:51

`Static`importFromGPX

importFromGPX(
    gpxString: string,
    domParser?: any,
    options?: ActivityParsingOptions,
): Promise<EventInterface>
Parses and returns an event using GPX format
Parameters
- gpxString: string
- OptionaldomParser: any
  custom DOMParser (case of NodeJs usage)
- Optionaloptions: ActivityParsingOptions
Returns Promise<EventInterface>
- Defined in src/index.ts:29

`Static`importFromJSON

importFromJSON(json: EventJSONInterface): EventInterface
Parses and returns an event using native format (SportsLib exported format)
Parameters
- json: EventJSONInterface
  EventJSONInterface
Returns EventInterface
- Defined in src/index.ts:71

`Static`importFromSuunto

importFromSuunto(
jsonString: string,
options?: ActivityParsingOptions,
): Promise<EventInterface>
Parses and returns an event using Suunto format
Parameters
- jsonString: string
- Optionaloptions: ActivityParsingOptions
Returns Promise<EventInterface>
- Defined in src/index.ts:63

`Static`importFromTCX

importFromTCX(
xmlDocument: XMLDocument,
options?: ActivityParsingOptions,
): Promise<EventInterface>
Parses and returns an event using TCX format
Parameters
- xmlDocument: XMLDocument
- Optionaloptions: ActivityParsingOptions
Returns Promise<EventInterface>
- Defined in src/index.ts:42

`Static`importRoutesFromFit

importRoutesFromFit(
arrayBuffer: ArrayBuffer | Buffer<ArrayBuffer>,
options?: RouteParsingOptions,
): Promise<RouteFileInterface>
Parses and returns first-class routes using FIT course format.
Parameters
- arrayBuffer: ArrayBuffer | Buffer<ArrayBuffer>
- Optionaloptions: RouteParsingOptions
Returns Promise<RouteFileInterface>
- Defined in src/index.ts:94

`Static`importRoutesFromGPX

importRoutesFromGPX(
    gpxString: string,
    domParser?: any,
    options?: RouteParsingOptions,
): Promise<RouteFileInterface>
Parses and returns first-class routes using GPX format.
Parameters
- gpxString: string
- OptionaldomParser: any
  custom DOMParser (case of NodeJs usage)
- Optionaloptions: RouteParsingOptions
Returns Promise<RouteFileInterface>
- Defined in src/index.ts:81

`Static`importRoutesFromJSON

importRoutesFromJSON(json: RouteFileJSONInterface): RouteFileInterface
Parses and returns first-class routes using native format (SportsLib exported format).
Parameters
- json: RouteFileJSONInterface
  RouteFileJSONInterface
Returns RouteFileInterface
- Defined in src/index.ts:105