Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MicroFrontendClass

Hierarchy

  • MicroFrontendClass

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • The constructor of the MicroFrontend class.

    Returns MicroFrontendClass

Properties

Readonly name

name: string

module identity for register purpose

Accessors

options

  • getter function for options

    Returns MicroFrontendConfigs | Record<any, any>

Methods

configure

  • configure<config>(arg: config): void

  • Add configuration to options property

    Type Parameters

    • config

    Parameters

    • arg: config

    Returns void

load

  • load(serviceName: string): Error | MicroApp

  • Load microapp into main app and configure xbase-js for microapp using main app's configuration

    Parameters

    • serviceName: string

    Returns Error | MicroApp

    MicroApp object

renderAsMicroApp

  • renderAsMicroApp(renderFunction: ((props?: Record<any, any>) => any), unmountFunction?: (() => any)): { bootstrap: any; mount: any; unmount: any }

  • render app as microapp

    Parameters

    • renderFunction: ((props?: Record<any, any>) => any)

      function callback for mount hook

        • (props?: Record<any, any>): any

        • Parameters

          • Optional props: Record<any, any>

          Returns any

    • Optional unmountFunction: (() => any)

      function callback for unmount hook (optional)

        • (): any

        • Returns any

    Returns { bootstrap: any; mount: any; unmount: any }

    • bootstrap:function
      • bootstrap(): void

      • Returns void

    • mount:function
      • mount(props: Record<any, any>): void

      • Parameters

        • props: Record<any, any>

        Returns void

    • unmount:function
      • unmount(): void

      • Returns void

unload

  • unload(microApp: MicroApp): Promise<void>

  • unload microapp from main app

    Parameters

    • microApp: MicroApp

    Returns Promise<void>

Generated using TypeDoc