Hevy SDK Documentation - v0.0.0
    Preparing search index...

    Class HevyClient

    Entry point for the Hevy SDK. It provides access to various sections of the API, such as workouts, by exposing them as properties.

    To use the SDK, import the HevyClient class and initialize it with your API key.

    import { HevyClient } from 'hevy-sdk';

    const client = new HevyClient('your-api-key');
    Index

    Constructors

    Properties

    Constructors

    • Creates an instance of the HevyClient. Initializes the client with the provided API key and exposes various API sections (e.g. workouts).

      Parameters

      • apiKey: string

        The API key used for authenticating requests to the Hevy API.

      Returns HevyClient

    Properties

    apiKey: string

    The API Key used for authentication with the Hevy API. This key is required for accessing the API sections.

    workouts: Workouts

    Exposes the Workouts section, which allows users to interact with workout-related functionality in the API.