Skip to content

v1.0.1 - Initial Stable Release

Choose a tag to compare

@paladini paladini released this 12 Dec 21:06
· 29 commits to main since this release

πŸŽ‰ Initial Release

First stable release of the intervals-icu TypeScript client library for the Intervals.icu API.

✨ Features

  • Full API Coverage: Support for all major Intervals.icu endpoints

    • Athlete information (get, update)
    • Events/Calendar entries (CRUD operations)
    • Wellness data (CRUD operations)
    • Workouts/Training plans (CRUD operations)
    • Activities (get, update, delete)
  • Developer Experience

    • πŸš€ Lightweight - Zero dependencies beyond axios
    • πŸ“˜ Fully Typed - Comprehensive TypeScript definitions
    • 🌳 Tree-shakeable - ESM exports for optimal bundle size
    • πŸ” Built-in authentication with API key
    • ⚑ Rate limiting awareness
    • πŸ›‘οΈ Robust error handling with custom error types
    • πŸ“– Well documented with JSDoc comments

πŸ“¦ Installation

npm install intervals-icu@1.0.1

πŸš€ Quick Start

import { IntervalsClient } from 'intervals-icu';

const client = new IntervalsClient({
  apiKey: 'your-api-key',
  athleteId: 'i12345' // optional
});

// Get athlete info
const athlete = await client.getAthlete();

// Get events
const events = await client.getEvents({
  oldest: '2024-01-01',
  newest: '2024-12-31'
});

// Create wellness entry
await client.createWellness({
  date: '2024-01-15',
  weight: 70,
  restingHR: 50
});

πŸ”— Links