Skip to content
MyCal Docs

SDK Installation

Install

Terminal window
npm install @catlabtech/mycal-sdk
# or
pnpm add @catlabtech/mycal-sdk
# or
yarn add @catlabtech/mycal-sdk

Node 18+ is required. The SDK is ESM-only and uses the platform fetch.

Import

import { MyCalClient } from "@catlabtech/mycal-sdk";


const cal = new MyCalClient();

No configuration needed — the SDK defaults to the production API.

Custom base URL

Useful if you’re running your own instance or testing against a staging deployment:

const cal = new MyCalClient({
  baseUrl: "https://your-worker.example.com/v1",
});

Types

The SDK re-exports types from @catlabtech/mycal-core so you don’t need a second install for type definitions:

import type {
  Holiday,
  State,
  SchoolTerm,
  BusinessDaysResult,
} from "@catlabtech/mycal-sdk";

Every method returns a Result<T> union:

type Result<T> =
  | { success: true; data: T }
  | { success: false; error: { code: string; message: string; status: number } };

This is a Result-pattern rather than throwing — see Client Usage for why and how.