Skip to main content

FitParserModule

FitFileViewer - API Documentation v30.0.1

FitFileViewer - API Documentation / shared/fitParser / FitParserModule

Interface: FitParserModule

Defined in: shared/fitParser.ts:114

Complete runtime export surface currently exposed by fitParser.js.

Properties​

applyUnknownMessageLabels​

applyUnknownMessageLabels: (messages: FitMessages) => FitMessages

Defined in: shared/fitParser.ts:115

Parameters​

messages​

FitMessages

Returns​

FitMessages

decodeFitFile​

decodeFitFile: (fileBuffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>, options?: Partial<DecoderOptions>, fitsdk?: FitSdkModule | null) => Promise<FitDecodeResult>

Defined in: shared/fitParser.ts:116

Parameters​

fileBuffer​

Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

options?​

Partial<DecoderOptions>

fitsdk?​

FitSdkModule | null

Returns​

Promise<FitDecodeResult>

DECODER_OPTIONS_SCHEMA​

DECODER_OPTIONS_SCHEMA: Record<keyof DecoderOptions, DecoderOptionSchemaEntry>

Defined in: shared/fitParser.ts:121

FitDecodeError​

FitDecodeError: FitDecodeErrorConstructor

Defined in: shared/fitParser.ts:125

getCurrentDecoderOptions​

getCurrentDecoderOptions: () => DecoderOptions

Defined in: shared/fitParser.ts:126

Returns​

DecoderOptions

getDefaultDecoderOptions​

getDefaultDecoderOptions: () => DecoderOptions

Defined in: shared/fitParser.ts:127

Returns​

DecoderOptions

getPersistedDecoderOptions​

getPersistedDecoderOptions: () => DecoderOptions

Defined in: shared/fitParser.ts:128

Returns​

DecoderOptions

initializeStateManagement​

initializeStateManagement: (stateManagers?: FitParserStateManagers) => void

Defined in: shared/fitParser.ts:129

Parameters​

stateManagers?​

FitParserStateManagers

Returns​

void

resetDecoderOptions​

resetDecoderOptions: () => DecoderOptionsUpdateResult

Defined in: shared/fitParser.ts:130

Returns​

DecoderOptionsUpdateResult

updateDecoderOptions​

updateDecoderOptions: (newOptions: Partial<DecoderOptions>) => DecoderOptionsUpdateResult

Defined in: shared/fitParser.ts:131

Parameters​

newOptions​

Partial<DecoderOptions>

Returns​

DecoderOptionsUpdateResult

validateDecoderOptions​

validateDecoderOptions: (options: Partial<DecoderOptions> | null | undefined) => DecoderOptionsValidationResult

Defined in: shared/fitParser.ts:134

Parameters​

options​

Partial<DecoderOptions> | null | undefined

Returns​

DecoderOptionsValidationResult