Class HttpClient

HTTP client for making requests to the Maximo API

Index

Properties

defaults leanMode apihome contextRoot cookieJar

Methods

getCookieDetails setLeanMode getAxiosInstance getLogger setDefaultHeader removeDefaultHeader get post put delete patch

Constructors

Properties

defaults

defaults: { headers: Record<string, string> }

leanMode

leanMode: boolean = true

apihome

apihome: string

contextRoot

contextRoot: string

cookieJar

cookieJar: CookieJar

Methods

getCookieDetails

getCookieDetails(cookies: string[]): string[]
Returns cookie names from raw Set-Cookie header values.
Parameters
- cookies: string[]
Returns string[]

setLeanMode

setLeanMode(enabled: boolean): void
Sets whether to use lean mode (reduced response payload) When enabled, 'lean=1' is added as a query parameter
Parameters
- enabled: boolean
  Whether to enable lean mode
Returns void

getAxiosInstance

getAxiosInstance(): AxiosInstance
Gets the underlying Axios instance

Returns AxiosInstance

getLogger

getLogger(): ILogger
Gets the logger associated with this HTTP client.

Returns ILogger

setDefaultHeader

setDefaultHeader(name: string, value: string): void
Sets a default header for all requests
Parameters
- name: string
  Header name
- value: string
  Header value
Returns void

removeDefaultHeader

removeDefaultHeader(name: string): void
Removes a default header
Parameters
- name: string
  Header name
Returns void

get

get<T = any>(
    url: string,
    params?: Record<string, string>,
    config?: AxiosRequestConfig<any>,
): Promise<AxiosResponse<T, any>>
Makes a GET request
Type Parameters
- T = any
Parameters
- url: string
  The URL to request
- Optionalparams: Record<string, string>
  Query parameters
- Optionalconfig: AxiosRequestConfig<any>
  Request configuration
Returns Promise<AxiosResponse<T, any>>
A promise resolving to the response

post

post<T = any>(
    url: string,
    data?: any,
    config?: AxiosRequestConfig<any>,
): Promise<AxiosResponse<T, any>>
Makes a POST request
Type Parameters
- T = any
Parameters
- url: string
  The URL to request
- Optionaldata: any
  The data to send
- Optionalconfig: AxiosRequestConfig<any>
  Request configuration
Returns Promise<AxiosResponse<T, any>>
A promise resolving to the response

put

put<T = any>(
    url: string,
    data?: any,
    config?: AxiosRequestConfig<any>,
): Promise<AxiosResponse<T, any>>
Makes a PUT request
Type Parameters
- T = any
Parameters
- url: string
  The URL to request
- Optionaldata: any
  The data to send
- Optionalconfig: AxiosRequestConfig<any>
  Request configuration
Returns Promise<AxiosResponse<T, any>>
A promise resolving to the response

delete

delete<T = any>(
url: string,
config?: AxiosRequestConfig<any>,
): Promise<AxiosResponse<T, any>>
Makes a DELETE request
Type Parameters
- T = any
Parameters
- url: string
  The URL to request
- Optionalconfig: AxiosRequestConfig<any>
  Request configuration
Returns Promise<AxiosResponse<T, any>>
A promise resolving to the response

patch

patch<T = any>(
    url: string,
    data?: any,
    config?: AxiosRequestConfig<any>,
): Promise<AxiosResponse<T, any>>
Makes a PATCH request
Type Parameters
- T = any
Parameters
- url: string
  The URL to request
- Optionaldata: any
  The data to send
- Optionalconfig: AxiosRequestConfig<any>
  Request configuration
Returns Promise<AxiosResponse<T, any>>
A promise resolving to the response

Constructors

constructor

new HttpClient(config: HttpClientConfig): HttpClient
Creates a new HTTP client
Parameters
- config: HttpClientConfig
  Client configuration
Returns HttpClient