From e9f72d67ba2844c2e0a2e352eec9a7139a8d26e6 Mon Sep 17 00:00:00 2001
From: Brendan Mortimer <mort@liminal.sh>
Date: Tue, 17 Mar 2026 13:22:22 -0700
Subject: [PATCH] fix: axiosConfig typo docs: add notes about API timeouts and
 large dataset performance

---
 index.d.ts | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/index.d.ts b/index.d.ts
index 2793afa..3425944 100644
--- a/index.d.ts
+++ b/index.d.ts
@@ -3,13 +3,17 @@ import type { AxiosRequestConfig } from "axios";
 export default class HockeyTech {
     /**
      * Constructor
+     *
+     * @note The HockeyTech API can be slow; consider setting a timeout via axiosConfig
+     * or making requests more granular to avoid requesting large datasets.
+     *
      * @param key string
      * @param clientCode string
      * @param language string Examples: en, fr
      * @param proxyBaseUrl string Example: http://localhost:3001/proxy?url=
      * @param axiosConfig AxiosRequestConfig Custom Axios configuration for all requests, e.g. to override the adapter for Cloudflare Workers
      */
-    constructor(key: string, clientCode: string, language?: string, proxyBaseUrl?: string, axoisConfig?: AxiosRequestConfig);
+    constructor(key: string, clientCode: string, language?: string, proxyBaseUrl?: string, axiosConfig?: AxiosRequestConfig);
 
     /**
      * Changes the default base url for the modulekit endpoints
@@ -70,6 +74,8 @@ export default class HockeyTech {
      * Retrieves the scorebar
      * @param numberOfDaysAhead number
      * @param numberOfDaysBack number
+     *
+     * @note Large date ranges (e.g. 1000+ days) may cause timeouts or slow responses (>30s).
      */
     getScorebar(numberOfDaysAhead: number, numberOfDaysBack: number): Promise<ScorebarResponse>;