Class Client

IQRF Gateway Webapp API client class

Client is a wrapper around API methods of IQRF Gateway Webapp providing shared configuration for Axios instance.

Instantiate with defaults

const client = new Client();

Instantiate with custom configuration

const config: AxiosRequestConfig = {
	baseURL: 'https://iqrf-gw.exaple.org/api/',
};
const client = new Client({ config });

Instantiate with custom Axios instance advanced

const config: AxiosRequestConfig = {
	baseURL: 'https://iqrf-gw.exaple.org/api/',
}
const axiosInstance = axios.create(config);
const client = new Client({ axiosInstance

Constructors

constructor

Methods

clearRequestInterceptors clearResponseInterceptors ejectRequestInterceptor ejectResponseInterceptor getAccountService getAxiosInstance getCloudServices getConfigServices getFeatureService getGatewayServices getInstallationService getIqrfServices getMaintenanceServices getNetworkServices getOpenApiService getSecurityServices getServiceService getVersionService setToken useRequestInterceptor useResponseInterceptor

Constructors

constructor

Methods

clearRequestInterceptors

  • clearRequestInterceptors(): void

    Clear all request interceptors

    Returns void

clearResponseInterceptors

  • clearResponseInterceptors(): void

    Clear all response interceptors

    Returns void

ejectRequestInterceptor

  • ejectRequestInterceptor(interceptorId: number): void

    Eject a request interceptor

    Parameters

    • interceptorId: number

      Interceptor ID

    Returns void

ejectResponseInterceptor

  • ejectResponseInterceptor(interceptorId: number): void

    Eject a response interceptor

    Parameters

    • interceptorId: number

      Interceptor ID

    Returns void

getAccountService

getAxiosInstance

getCloudServices

getConfigServices

getFeatureService

getGatewayServices

getInstallationService

getIqrfServices

getMaintenanceServices

getNetworkServices

getOpenApiService

getSecurityServices

getServiceService

getVersionService

setToken

  • setToken(token: null | string): void

    Sets API key or JWT token

    Parameters

    • token: null | string

      API key or JWT token

    Returns void

    Todo

    Implement API key and JWT validation

useRequestInterceptor

  • useRequestInterceptor(
        onFulfilled?:
            | null
            | (
                value: InternalAxiosRequestConfig,
            ) =>
                | InternalAxiosRequestConfig<any>
                | Promise<InternalAxiosRequestConfig<any>>,
        onRejected?: null | (error: any) => any,
        options?: AxiosInterceptorOptions,
    ): number

    Add a request interceptor

    Parameters

    • OptionalonFulfilled:
          | null
          | (
              value: InternalAxiosRequestConfig,
          ) =>
              | InternalAxiosRequestConfig<any>
              | Promise<InternalAxiosRequestConfig<any>>

      Fulfilled callback

    • OptionalonRejected: null | (error: any) => any

      Rejected callback

    • Optionaloptions: AxiosInterceptorOptions

      Interceptor options

    Returns number

    Interceptor ID

useResponseInterceptor

  • useResponseInterceptor(
        onFulfilled?:
            | null
            | (
                value: AxiosResponse,
            ) => AxiosResponse<any, any> | Promise<AxiosResponse<any, any>>,
        onRejected?: null | (error: any) => any,
    ): number

    Add a response interceptor

    Parameters

    • OptionalonFulfilled:
          | null
          | (
              value: AxiosResponse,
          ) => AxiosResponse<any, any> | Promise<AxiosResponse<any, any>>

      Fulfilled callback

    • OptionalonRejected: null | (error: any) => any

      Rejected callback

    Returns number

    Interceptor ID

Settings

Member Visibility

On This Page

IQRF Gateway Webapp API client class
Constructors
Methods