IQRF Repository API client class

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

Instantiate with defaults

const client = new Client();

Instantiate with custom configuration

const config: AxiosRequestConfig = {
baseURL: 'https://devrepo.iqrfalliance.org/api/',
};
const client = new Client({config});

Instantiate with custom Axios instance advanced

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

Hierarchy

  • Client

Constructors

  • Constructs IQRF Repository API client

    Parameters

    Returns Client

Properties

axiosInstance: AxiosInstance

Axios instance

defaultAxiosConfig: AxiosRequestConfig<any> = ...

Default Axios instance configuration

Methods

  • Clears all request interceptors

    Returns void

  • Clears all response interceptors

    Returns void

  • Ejects a request interceptor

    Parameters

    • interceptorId: number

      Interceptor ID

    Returns void

  • Ejects a response interceptor

    Parameters

    • interceptorId: number

      Interceptor ID

    Returns void

  • Returns DPA version service

    Returns DpaService

    DPA version service

  • Returns IQRF OS & DPA version service

    Returns OsDpaService

    IQRF OS & DPA version service

  • Returns IQRF OS version service

    Returns OsService

    IQRF OS version service

  • Checks if client has credentials set

    Returns boolean

    true if client has credentials set, false otherwise

  • Adds a request interceptor

    Parameters

    • Optional onFulfilled: null | ((value) => InternalAxiosRequestConfig<any> | Promise<InternalAxiosRequestConfig<any>>)

      Fulfilled callback

    • Optional onRejected: null | ((error) => any)

      Rejected callback

    • Optional options: AxiosInterceptorOptions

      Interceptor options

    Returns number

    Interceptor ID

  • Adds a response interceptor

    Parameters

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

      Fulfilled callback

    • Optional onRejected: null | ((error) => any)

      Rejected callback

    • Optional options: AxiosInterceptorOptions

      Interceptor options

    Returns number

    Interceptor ID

Generated using TypeDoc