Class SWCombine

constructor

• new SWCombine(config?: ClientConfig): SWCombine

  Parameters

  • config: ClientConfig = {}

  Returns SWCombine

Readonlyapi

Readonlyauth

Readonlycharacter

Readonlydatacard

Readonlyevents

Readonlyfaction

Readonlygalaxy

Readonlyinventory

Readonlylocation

Readonlymarket

Readonlynews

Readonlytypes

clearToken

• clearToken(): void

  Clear the token

  Returns void

getRateLimitInfo

• getRateLimitInfo(): RateLimitInfo | null

  Get the current rate limit information. Returns the last known rate limit info from API response headers. Returns null if no API calls have been made yet.

  Note: The SW Combine API has a default limit of 600 requests per hour.

  Returns RateLimitInfo | null

  Example

  const rateLimit = client.getRateLimitInfo();
  if (rateLimit) {
    console.log(`${rateLimit.remaining}/${rateLimit.limit} requests remaining`);
    console.log(`Resets at: ${rateLimit.resetTime}`);
  }
  Copy

getToken

• getToken(): OAuthToken | null

  Get the current token

  Returns OAuthToken | null

hasRefreshToken

• hasRefreshToken(): boolean

  Check if refresh token is available

  Returns boolean

isTokenExpired

• isTokenExpired(): boolean

  Check if token is expired

  Returns boolean

onRateLimitUpdate

• onRateLimitUpdate(callback: (info: RateLimitInfo) => void): void

  Set a callback to be notified when rate limit info is updated after each API call. Useful for monitoring rate limit consumption in real-time.

  Parameters

  • callback: (info: RateLimitInfo) => void

  Returns void

  Example

  client.onRateLimitUpdate((info) => {
    if (info.remaining < 100) {
      console.warn(`Warning: Only ${info.remaining} API requests remaining!`);
    }
  });
  Copy

refreshToken

• refreshToken(): Promise<void>

  Manually refresh the token

  Returns Promise<void>

setToken

• setToken(token: string | OAuthToken): void

  Set the access token

  Parameters

  • token: string | OAuthToken

  Returns void