npm.io
10.0.0 • Published 2d ago

@kaiord/fit

Licence
MIT
Version
10.0.0
Deps
3
Size
316 kB
Vulns
0
Weekly
0
Stars
7

@kaiord/fit

npm version License: MIT

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/fit

Usage

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

Keywords