Constructors

Methods

  • Makes an HTTP request with retry logic and error handling

    Type Parameters

    • T = any

      Expected response data type

    Parameters

    • config: RequestConfig

      Request configuration

    Returns Promise<APIResponse<T>>

    Promise resolving to API response

    Throws

    When network connectivity fails

    Throws

    When API returns an error response

    Throws

    When request times out

    Example

    const response = await httpClient.request<Device[]>({
    method: 'GET',
    url: '/api/s/default/stat/device',
    retries: 3
    });
  • Makes a GET request

    Type Parameters

    • T = any

      Expected response data type

    Parameters

    • url: string

      Request URL

    • Optional options: RequestOptions & {
          signal?: AbortSignal;
      }

      Request options including signal for cancellation

    Returns Promise<APIResponse<T>>

    Promise resolving to API response

    Example

    const devices = await httpClient.get<Device[]>('/api/s/default/stat/device');
    
  • Makes a POST request

    Type Parameters

    • T = any

      Expected response data type

    Parameters

    • url: string

      Request URL

    • Optional data: any

      Request body data

    • Optional options: RequestOptions & {
          signal?: AbortSignal;
      }

      Request options including signal for cancellation

    Returns Promise<APIResponse<T>>

    Promise resolving to API response

    Example

    const result = await httpClient.post('/api/s/default/cmd/stamgr', {
    cmd: 'authorize-guest',
    mac: '00:11:22:33:44:55'
    });
  • Makes a PUT request

    Type Parameters

    • T = any

      Expected response data type

    Parameters

    • url: string

      Request URL

    • Optional data: any

      Request body data

    • Optional options: RequestOptions & {
          signal?: AbortSignal;
      }

      Request options including signal for cancellation

    Returns Promise<APIResponse<T>>

    Promise resolving to API response

  • Makes a DELETE request

    Type Parameters

    • T = any

      Expected response data type

    Parameters

    • url: string

      Request URL

    • Optional options: RequestOptions & {
          signal?: AbortSignal;
      }

      Request options including signal for cancellation

    Returns Promise<APIResponse<T>>

    Promise resolving to API response

  • Updates the base URL for all requests

    Parameters

    • url: string

      New base URL

    Returns void

  • Updates the request timeout

    Parameters

    • timeout: number

      Timeout in milliseconds

    Returns void

  • Gets the current cookie jar instance

    Returns CookieJar

    The cookie jar containing session cookies

  • Sets a new cookie jar instance

    Parameters

    • jar: CookieJar

      Cookie jar to use for session management

    Returns void

  • Clears all cookies from the cookie jar

    This effectively logs out the client by removing session cookies.

    Returns void

  • Restores the original SSL verification settings

    This restores the NODE_TLS_REJECT_UNAUTHORIZED environment variable to its original value if it was modified during construction.

    Returns void