Options
All
  • Public
  • Public/Protected
  • All
Menu

@xtremax/xbase-js

Index

Modules

Variables

Functions

Methods

Variables

API

API: APIInstance

Instance of Axios for API fetching. This works just like any axios instance, but added defaultResponseInterceptors and defaultRequestInterceptors.

Auth

Auth: InstanceType<typeof AuthClass>

Instance of AuthClass to be used by user. This works just like oidc-client's UserManager, but with default configurations and additional simplified methods, and integrated with inactiveDetector

Const MicroFrontend

MicroFrontend: MicroFrontendClass = ...

Instance of MicroFrontend class to be registered

Const PubSub

PubSub: PubSubClass = ...

default

default: XBaseJS

Instance of XBaseJS class where all imported module(s) will be registered.

Functions

InactiveDetector

  • InactiveDetector(callback: (() => void), waitingTime?: number, activeState?: (() => void), otherOptions?: default): default

  • Parameters

    • callback: (() => void)
        • (): void

        • Returns void

    • waitingTime: number = ...
    • activeState: (() => void) = ...
        • (): void

        • Returns void

    • otherOptions: default = ...

    Returns default

Methods

Permission

  • Permission(permissionKey: string | string[]): Promise<boolean>

  • Validate user's permission based on key

    Parameters

    • permissionKey: string | string[]

      String

    Returns Promise<boolean>

Generated using TypeDoc