Options
All
  • Public
  • Public/Protected
  • All
Menu

Module <internal>

Index

Classes

Interfaces

Type Aliases

Variables

Type Aliases

APIConfigs

APIConfigs: { config?: AxiosRequestConfig; errorHandler?: ErrorHandler }

Configuration for API. consists of config option of type AxiosRequestConfig and optional errorHandler options.

Type declaration

  • Optional config?: AxiosRequestConfig
  • Optional errorHandler?: ErrorHandler

AuthConfigs

AuthConfigs: { idpConfigs: IdpConfigs; inactiveDetectorConfigs?: false | InactiveDetectorConfigs }

Configuration for Auth

Type declaration

ErrorHandler

ErrorHandler: { statusCode: number | number[]; callback: any }[]

Array of object contains status code and its respective errorHandler

IdpConfigs

IdpConfigs: Omit<UserManagerSettings, "userStore">

Configuration to construct oidc-client's UserManager instance. Extends UserManagerSettings

InactiveDetectorConfigs

InactiveDetectorConfigs: { inactiveTimeout?: number; preInactiveTimeout?: number; inactiveCallback?: any; preInactiveCallback?: any }

Optional configuration for inactivity detector feature

Type declaration

  • Optional inactiveTimeout?: number
  • Optional preInactiveTimeout?: number
  • inactiveCallback?:function
    • inactiveCallback(): void

    • Returns void

  • preInactiveCallback?:function
    • preInactiveCallback(resetTimer?: ResetTimer): void

    • Parameters

      Returns void

MicroFrontendConfigs

MicroFrontendConfigs: { microApps: appData[] }

Type declaration

PermissionConfigs

PermissionConfigs: { permissionResolver: (() => Promise<PermissionData>) | PermissionData }

Configuration for Permission

Type declaration

PermissionData

PermissionData: {}

Object contains permission data in the form of [permission name] : value

Type declaration

  • [key: string]: boolean

PubSubConfigs

PubSubConfigs: { validator?: any }

Configuration for PubSub module

Type declaration

  • validator?:function
    • validator(): boolean

    • Returns boolean

ResetTimer

ResetTimer: (() => void)

Type declaration

    • (): void

    • Returns void

Subscriptions

Subscriptions: { options: boolean | AddEventListenerOptions; token: string; type: string; listener: any }

Subscription details

Type declaration

  • options: boolean | AddEventListenerOptions
  • token: string
  • type: string
  • listener:function
    • listener(e: CustomEvent<any>): any

    • Parameters

      • e: CustomEvent<any>

      Returns any

XBaseJsConfigs

XBaseJsConfigs: { API?: APIConfigs; Auth?: AuthConfigs; MicroFrontend?: MicroFrontendConfigs; Permission?: PermissionConfigs; PubSub?: PubSubConfigs }

Object contains configurations for imported modules

Type declaration

appData

appData: { container: string; entry: string; name: string; props?: Record<any, any> }

Type declaration

  • container: string
  • entry: string
  • name: string
  • Optional props?: Record<any, any>

Variables

APIInstance

APIInstance: APIClass

Instance of API class to be registered

Generated using TypeDoc