@kaiord/fit
v4.7.2
Published
FIT format adapter for the Kaiord health & fitness data framework
Downloads
647
Maintainers
Readme
@kaiord/fit
FIT format adapter for the Kaiord health & fitness data framework. Provides reading and writing of Garmin FIT workout files using the official Garmin FIT SDK.
Installation
pnpm add @kaiord/core @kaiord/fitUsage
With Core Providers (Recommended)
import { createDefaultProviders } from "@kaiord/core";
import { createFitProviders } from "@kaiord/fit";
const providers = createDefaultProviders({
fit: createFitProviders(),
});
// FIT to KRD
const krd = await providers.convertFitToKrd!({ fitBuffer });
// KRD to FIT
const fitBuffer = await providers.convertKrdToFit!({ krd });Standalone Adapter Access
import {
createGarminFitSdkReader,
createGarminFitSdkWriter,
} from "@kaiord/fit";
import { createConsoleLogger } from "@kaiord/core";
const logger = createConsoleLogger();
const reader = createGarminFitSdkReader(logger);
const writer = createGarminFitSdkWriter(logger);API
createFitProviders(logger?: Logger): FitProviders
Creates FIT adapter instances for use with createDefaultProviders().
createGarminFitSdkReader(logger: Logger): FitReader
Creates a FIT file reader using the Garmin FIT SDK.
createGarminFitSdkWriter(logger: Logger): FitWriter
Creates a FIT file writer using the Garmin FIT SDK.
Supported FIT Features
- Workout files (structured workout steps)
- Activity files (recorded activity data)
- Course files (GPS routes)
- Lap messages
- Record messages (time-series data)
- Event messages
- Session/activity metadata
License
MIT
