Skip to content

fix: axiosConfig typo #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bmortimer wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

fix: axiosConfig typo #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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>;

Expand Down