diff --git a/classes/app.GlobalBrowserApi.html b/classes/app.GlobalBrowserApi.html index 3c4038c..937dd9d 100644 --- a/classes/app.GlobalBrowserApi.html +++ b/classes/app.GlobalBrowserApi.html @@ -27,7 +27,7 @@

Hierarchy

+
  • Defined in app/GlobalBrowserApi.ts:17
    • @@ -70,7 +70,7 @@

    Example

    const<
    +
  • Defined in app/GlobalBrowserApi.ts:70

    • Static mountRootParcel

    mountRootParcel: MountParcel = ...
    @@ -80,7 +80,7 @@

    Example

    const<
    +
  • Defined in app/GlobalBrowserApi.ts:58

    • Methods

    @@ -100,7 +100,7 @@

    Parameters

    name: string

    Returns Promise<undefined | ApplicationConfig<T>>

    +
  • Defined in app/GlobalBrowserApi.ts:85

    • Static importParcelFromApp

    Returns Promise<LifeCycles<ParcelLifecycleFnProps<ExtraProps>>>

    +
  • Defined in app/GlobalBrowserApi.ts:40

    • Static isIlcEnvironment

    +
  • Defined in app/GlobalBrowserApi.ts:89

    • Static loadApp

    Returns Promise<T & LifeCycles<AppLifecycleFnProps<unknown> | AppWrapperLifecycleFnProps<unknown> | ParcelLifecycleFnProps>>

    +
  • Defined in app/GlobalBrowserApi.ts:74

    • Static navigate

    Returns void

    +
  • Defined in app/GlobalBrowserApi.ts:22

    • Static unloadApp

    Returns void

    +
  • Defined in app/GlobalBrowserApi.ts:81
    • diff --git a/classes/app.IlcAppSdk.html b/classes/app.IlcAppSdk.html index d3ea4ca..a22a9f6 100644 --- a/classes/app.IlcAppSdk.html +++ b/classes/app.IlcAppSdk.html @@ -29,7 +29,7 @@

    Implements

    +
  • Defined in app/index.ts:56
    • @@ -66,7 +66,7 @@
    adapter: Optional options: OptionsSdk

    Returns IlcAppSdk

    +
  • Defined in app/index.ts:63

    • Properties

    @@ -76,19 +76,19 @@

    appId

    +
  • Defined in app/index.ts:59

    • Optional Readonly cssBundle

    cssBundle?: string
    +
  • Defined in app/index.ts:61

    • intl

    intl: IlcIntl
    +
  • Defined in app/index.ts:57

    • render404

    render404: Render404 = ...
    @@ -102,7 +102,7 @@

    render404

    +
  • Defined in app/index.ts:87

    • Methods

    @@ -112,7 +112,7 @@

    unmount

    Returns void

    +
  • Defined in app/index.ts:91
    • diff --git a/classes/app.IlcIntl.html b/classes/app.IlcIntl.html index 648975c..662e2cf 100644 --- a/classes/app.IlcIntl.html +++ b/classes/app.IlcIntl.html @@ -24,7 +24,7 @@

    Hierarchy

    • IlcIntl
    +
  • Defined in app/IlcIntl.ts:10
    • @@ -64,7 +64,7 @@
    Optional adapter: Optional options: OptionsIntl

    Returns IlcIntl

    +
  • Defined in app/IlcIntl.ts:15

    • Methods

    @@ -76,7 +76,7 @@

    getReturns Required<IntlConfig>

    +
  • Defined in app/IlcIntl.ts:30

    • getDefault

    +
  • Defined in app/IlcIntl.ts:37

    • getLocalisationManifestPath

      @@ -97,7 +97,7 @@

      getLocalisationManifestPath<

    Returns undefined | string

    +
  • Defined in app/IlcIntl.ts:66

    • getSupported

    +
  • Defined in app/IlcIntl.ts:44

    • localizeUrl

    Returns string

    +
  • Defined in app/IlcIntl.ts:76

    • onChange

    +
  • Defined in app/IlcIntl.ts:95

    • parseUrl

    +
  • Defined in app/IlcIntl.ts:85

    • set

    Returns void

    +
  • Defined in app/IlcIntl.ts:53

    • unmount

    +
  • Defined in app/IlcIntl.ts:128
    • diff --git a/classes/server.IlcAppWrapperSdk.html b/classes/server.IlcAppWrapperSdk.html index 91f45c1..21aeb95 100644 --- a/classes/server.IlcAppWrapperSdk.html +++ b/classes/server.IlcAppWrapperSdk.html @@ -26,7 +26,7 @@

    Hierarchy

    • IlcAppWrapperSdk
    +
  • Defined in server/IlcAppWrapperSdk.ts:6
    • @@ -62,7 +62,7 @@
    Optional loggerReturns IlcAppWrapperSdk
    +
  • Defined in server/IlcSdk.ts:26

    • Methods

    @@ -85,7 +85,7 @@
    appAssets: Returns void
    +
  • Defined in server/IlcSdk.ts:143

    • forwardRequest

    Returns void

    +
  • Defined in server/IlcAppWrapperSdk.ts:7

    • processRequest

      @@ -123,7 +123,7 @@
      req: IncomingMessage
    <

    Returns ProcessedRequest<RegistryProps>

    +
  • Defined in server/IlcSdk.ts:33
    • diff --git a/classes/server.IlcSdk.html b/classes/server.IlcSdk.html index 76a8c06..4a0a67a 100644 --- a/classes/server.IlcSdk.html +++ b/classes/server.IlcSdk.html @@ -26,7 +26,7 @@

    Hierarchy

    +
  • Defined in server/IlcSdk.ts:15
    • @@ -60,7 +60,7 @@
    Optional loggerReturns IlcSdk
    +
  • Defined in server/IlcSdk.ts:26

    • Methods

    @@ -82,7 +82,7 @@
    res: ServerResponseAppAssets

    Returns void

    +
  • Defined in server/IlcSdk.ts:143

    • processRequest

      @@ -102,7 +102,7 @@

      Parameters

      req: IncomingMessage

    Returns ProcessedRequest<RegistryProps>

    +
  • Defined in server/IlcSdk.ts:33
    • diff --git a/classes/server.RegistryApi.html b/classes/server.RegistryApi.html index d6a8d7c..fea4d44 100644 --- a/classes/server.RegistryApi.html +++ b/classes/server.RegistryApi.html @@ -24,7 +24,7 @@

    Hierarchy

    • RegistryApi
    +
  • Defined in server/RegistryApi.ts:21
    • @@ -56,7 +56,7 @@
    registryOrigin: string
    options: Options = {}

    Returns RegistryApi

    +
  • Defined in server/RegistryApi.ts:37

    • Methods

    @@ -74,7 +74,7 @@

    Parameters

    Optional query: DiscoveryMetadata

    Returns Promise<ListDiscoveredApps>

    +
  • Defined in server/RegistryApi.ts:52
    • diff --git a/enums/app.ApplicationKind.html b/enums/app.ApplicationKind.html index f287f33..6c6f578 100644 --- a/enums/app.ApplicationKind.html +++ b/enums/app.ApplicationKind.html @@ -17,7 +17,7 @@
  • ApplicationKind

    • Enumeration ApplicationKind

    +
  • Defined in app/interfaces/AppConfig.ts:12
    • @@ -36,22 +36,22 @@

    Enumeration Members

    Essential

    Essential: "essential"
    +
  • Defined in app/interfaces/AppConfig.ts:15

    • Primary

    Primary: "primary"
    +
  • Defined in app/interfaces/AppConfig.ts:14

    • Regular

    Regular: "regular"
    +
  • Defined in app/interfaces/AppConfig.ts:13

    • Wrapper

    Wrapper: "wrapper"
    +
  • Defined in app/interfaces/AppConfig.ts:16
    • diff --git a/enums/app.RoutingStrategy.html b/enums/app.RoutingStrategy.html index 3cacf0a..9af70f5 100644 --- a/enums/app.RoutingStrategy.html +++ b/enums/app.RoutingStrategy.html @@ -17,7 +17,7 @@
  • RoutingStrategy

    • Enumeration RoutingStrategy

    +
  • Defined in app/interfaces/common.ts:12
    • @@ -34,12 +34,12 @@

    Enumeration Members

    Prefix

    Prefix: "prefix"
    +
  • Defined in app/interfaces/common.ts:14

    • PrefixExceptDefault

    PrefixExceptDefault: "prefix_except_default"
    +
  • Defined in app/interfaces/common.ts:13
    • diff --git a/functions/app.isSpecialUrl.html b/functions/app.isSpecialUrl.html index 852256c..2d0d4df 100644 --- a/functions/app.isSpecialUrl.html +++ b/functions/app.isSpecialUrl.html @@ -27,7 +27,7 @@

    Parameters

    url: string

    Returns boolean

    +
  • Defined in app/utils/isSpecialUrl.ts:1
    • diff --git a/functions/server.WebpackPluginsFactory.html b/functions/server.WebpackPluginsFactory.html index 7317fe3..d58e1ec 100644 --- a/functions/server.WebpackPluginsFactory.html +++ b/functions/server.WebpackPluginsFactory.html @@ -40,7 +40,7 @@
    client:
    server: any[]
    +
  • Defined in server/WebpackPlugins.ts:26
    • diff --git a/interfaces/app.AppLifecycleFnProps.html b/interfaces/app.AppLifecycleFnProps.html index 13bade8..40cc174 100644 --- a/interfaces/app.AppLifecycleFnProps.html +++ b/interfaces/app.AppLifecycleFnProps.html @@ -33,7 +33,7 @@

    Hierarchy

    +
  • Defined in app/interfaces/AppLifecycleFnProps.ts:8
    • @@ -57,7 +57,7 @@

    appSdk

    Isomorphic API that can be used during SSR & CSR. Documentation

    +
  • Defined in app/interfaces/AppLifecycleFnProps.ts:31

    • domElementGetter

    domElementGetter: (() => HTMLElement)
    @@ -72,14 +72,14 @@

    Type declaration

    Returns HTMLElement

    +
  • Defined in app/interfaces/AppLifecycleFnProps.ts:12

    • errorHandler

    errorHandler: ErrorHandler

    App MUST use it to propagate all unhandled errors. Usually it's used in app's adapter.

    +
  • Defined in app/interfaces/AppLifecycleFnProps.ts:27

    • getCurrentBasePath

    getCurrentBasePath: (() => string)
    @@ -96,7 +96,7 @@

    Type declaration

    Returns string

    +
  • Defined in app/interfaces/AppLifecycleFnProps.ts:23

    • getCurrentPathProps

    getCurrentPathProps: (() => RegProps)
    @@ -111,7 +111,7 @@

    Type declaration

    Returns RegProps

    +
  • Defined in app/interfaces/AppLifecycleFnProps.ts:16

    • mountParcel

    mountParcel: MountParcel
    @@ -120,7 +120,7 @@

    mountParcel

    +
  • Defined in app/interfaces/SingleSpaLifecycleFnProps.ts:11

    • name

    name: string
    @@ -128,7 +128,7 @@

    name

    Inherited from SingleSpaLifecycleFnProps.name

    +
  • Defined in app/interfaces/SingleSpaLifecycleFnProps.ts:5
    • diff --git a/interfaces/app.AppSdkAdapter.html b/interfaces/app.AppSdkAdapter.html index d52648a..537da6a 100644 --- a/interfaces/app.AppSdkAdapter.html +++ b/interfaces/app.AppSdkAdapter.html @@ -26,7 +26,7 @@

    Hierarchy

    +
  • Defined in app/interfaces/common.ts:26
    • @@ -46,12 +46,12 @@

    appId

    Unique application ID, if same app will be rendered twice on a page - it will get different IDs

    +
  • Defined in app/interfaces/common.ts:28

    • intl

    intl: null | IntlAdapter
    +
  • Defined in app/interfaces/common.ts:29

    • trigger404Page

    trigger404Page: ((withCustomContent?: boolean) => void)
    @@ -69,7 +69,7 @@

    Parameters

    Optional withCustomContent: boolean

    Returns void

    +
  • Defined in app/interfaces/common.ts:30
    • diff --git a/interfaces/app.AppWrapperLifecycleFnProps.html b/interfaces/app.AppWrapperLifecycleFnProps.html index 34cf1f8..54e4920 100644 --- a/interfaces/app.AppWrapperLifecycleFnProps.html +++ b/interfaces/app.AppWrapperLifecycleFnProps.html @@ -31,7 +31,7 @@

    Hierarchy

    • AppWrapperLifecycleFnProps
    +
  • Defined in app/interfaces/AppWrapperLifecycleFnProps.ts:7
    • @@ -59,7 +59,7 @@

    appSdk

    +
  • Defined in app/interfaces/AppLifecycleFnProps.ts:31

    • Optional appWrapperData

    appWrapperData?: {
        appId: string;
    }
    @@ -73,7 +73,7 @@

    Type declaration

  • appId: string
    • +
  • Defined in app/interfaces/AppWrapperLifecycleFnProps.ts:18

    • domElementGetter

    domElementGetter: (() => HTMLElement)
    @@ -89,7 +89,7 @@

    Type declaration

    Returns HTMLElement

    +
  • Defined in app/interfaces/AppLifecycleFnProps.ts:12

    • errorHandler

    errorHandler: ErrorHandler
    @@ -97,7 +97,7 @@

    errorHandler

    Inherited from AppLifecycleFnProps.errorHandler

    +
  • Defined in app/interfaces/AppLifecycleFnProps.ts:27

    • getCurrentBasePath

    getCurrentBasePath: (() => string)
    @@ -115,7 +115,7 @@

    Type declaration

    Returns string

    +
  • Defined in app/interfaces/AppLifecycleFnProps.ts:23

    • getCurrentPathProps

    getCurrentPathProps: (() => RegProps)
    @@ -131,7 +131,7 @@

    Type declaration

    Returns RegProps

    +
  • Defined in app/interfaces/AppLifecycleFnProps.ts:16

    • Optional getWrappedAppProps

    getWrappedAppProps?: (() => RegProps)
    @@ -146,7 +146,7 @@

    Type declaration

    Returns RegProps

    +
  • Defined in app/interfaces/AppWrapperLifecycleFnProps.ts:25

    • mountParcel

    mountParcel: MountParcel
    @@ -155,7 +155,7 @@

    mountParcel

    +
  • Defined in app/interfaces/SingleSpaLifecycleFnProps.ts:11

    • name

    name: string
    @@ -163,7 +163,7 @@

    name

    Inherited from AppLifecycleFnProps.name

    +
  • Defined in app/interfaces/SingleSpaLifecycleFnProps.ts:5

    • renderApp

    renderApp: (<T>(props: T) => Promise<void>)
    @@ -189,7 +189,7 @@

    Parameters

    props: T

    Returns Promise<void>

    +
  • Defined in app/interfaces/AppWrapperLifecycleFnProps.ts:12
    • diff --git a/interfaces/app.ApplicationConfig.html b/interfaces/app.ApplicationConfig.html index 0f2bb86..198a6f6 100644 --- a/interfaces/app.ApplicationConfig.html +++ b/interfaces/app.ApplicationConfig.html @@ -26,7 +26,7 @@

    Hierarchy

    • ApplicationConfig
    +
  • Defined in app/interfaces/AppConfig.ts:1
    • @@ -49,42 +49,42 @@

    Properties

    Optional cssBundle

    cssBundle?: string
    +
  • Defined in app/interfaces/AppConfig.ts:5

    • Optional dependencies

    dependencies?: Record<string, string>
    +
  • Defined in app/interfaces/AppConfig.ts:9

    • kind

    kind: ApplicationKind
    +
  • Defined in app/interfaces/AppConfig.ts:3

    • Optional l10nManifest

    l10nManifest?: string
    +
  • Defined in app/interfaces/AppConfig.ts:6

    • name

    name: string
    +
  • Defined in app/interfaces/AppConfig.ts:2

    • Optional props

    props?: T
    +
  • Defined in app/interfaces/AppConfig.ts:8

    • Optional spaBundle

    spaBundle?: string
    +
  • Defined in app/interfaces/AppConfig.ts:4

    • Optional wrappedWith

    wrappedWith?: string
    +
  • Defined in app/interfaces/AppConfig.ts:7
    • diff --git a/interfaces/app.IIlcAppSdk.html b/interfaces/app.IIlcAppSdk.html index 923d282..93ba75f 100644 --- a/interfaces/app.IIlcAppSdk.html +++ b/interfaces/app.IIlcAppSdk.html @@ -25,7 +25,7 @@

    Implemented by

    +
  • Defined in app/interfaces/IIlcAppSdk.ts:4
    • @@ -46,22 +46,22 @@

    appId

    Unique application ID, if same app will be rendered twice on a page - it will get different IDs

    +
  • Defined in app/interfaces/IIlcAppSdk.ts:6

    • Optional cssBundle

    cssBundle?: string
    +
  • Defined in app/interfaces/IIlcAppSdk.ts:9

    • intl

    intl: IlcIntl
    +
  • Defined in app/interfaces/IIlcAppSdk.ts:7

    • render404

    render404: Render404
    +
  • Defined in app/interfaces/IIlcAppSdk.ts:8
    • diff --git a/interfaces/app.IntlAdapter.html b/interfaces/app.IntlAdapter.html index 51279e4..2183716 100644 --- a/interfaces/app.IntlAdapter.html +++ b/interfaces/app.IntlAdapter.html @@ -24,7 +24,7 @@

    Hierarchy

    • IntlAdapter
    +
  • Defined in app/interfaces/common.ts:4
    • @@ -42,7 +42,7 @@

    Properties

    config

    config: IntlAdapterConfig
    +
  • Defined in app/interfaces/common.ts:5

    • get

    get: (() => Required<IntlConfig>)
    @@ -57,7 +57,7 @@

    Type declaration

    Returns Required<IntlConfig>

    +
  • Defined in app/interfaces/common.ts:7

    • Optional set

    set?: ((p: IntlConfig) => void)
    @@ -77,7 +77,7 @@

    Parameters

    p: IntlConfig

    Returns void

    +
  • Defined in app/interfaces/common.ts:9
    • diff --git a/interfaces/app.IntlAdapterConfig.html b/interfaces/app.IntlAdapterConfig.html index ff52395..2468e2e 100644 --- a/interfaces/app.IntlAdapterConfig.html +++ b/interfaces/app.IntlAdapterConfig.html @@ -21,7 +21,7 @@

    Hierarchy

    • IntlAdapterConfig
    +
  • Defined in app/interfaces/common.ts:17
    • @@ -39,12 +39,12 @@

    Properties

    default

    default: Required<IntlConfig>
    +
  • Defined in app/interfaces/common.ts:18

    • routingStrategy

    routingStrategy: RoutingStrategy
    +
  • Defined in app/interfaces/common.ts:20

    • supported

    supported: {
        currency: string[];
        locale: string[];
    }
    @@ -56,7 +56,7 @@
    currency:
    locale: string[]
    +
  • Defined in app/interfaces/common.ts:19
    • diff --git a/interfaces/app.IntlConfig.html b/interfaces/app.IntlConfig.html index cddfb42..bcb6b57 100644 --- a/interfaces/app.IntlConfig.html +++ b/interfaces/app.IntlConfig.html @@ -21,7 +21,7 @@

    Hierarchy

    • IntlConfig
    +
  • Defined in app/interfaces/common.ts:35
    • @@ -38,12 +38,12 @@

    Properties

    Optional currency

    currency?: string
    +
  • Defined in app/interfaces/common.ts:37

    • Optional locale

    locale?: string
    +
  • Defined in app/interfaces/common.ts:36
    • diff --git a/interfaces/app.IntlUpdateEvent.html b/interfaces/app.IntlUpdateEvent.html index 1223530..6b0aeb4 100644 --- a/interfaces/app.IntlUpdateEvent.html +++ b/interfaces/app.IntlUpdateEvent.html @@ -21,7 +21,7 @@

    Hierarchy

    • IntlUpdateEvent
    +
  • Defined in app/types.ts:17
    • @@ -38,12 +38,12 @@

    Properties

    currency

    currency: string
    +
  • Defined in app/types.ts:19

    • locale

    locale: string
    +
  • Defined in app/types.ts:18
    • diff --git a/interfaces/app.LifeCycles.html b/interfaces/app.LifeCycles.html index 6fbbd6f..ba2b889 100644 --- a/interfaces/app.LifeCycles.html +++ b/interfaces/app.LifeCycles.html @@ -26,7 +26,7 @@

    Hierarchy

    • LifeCycles
    +
  • Defined in app/interfaces/LifeCycles.ts:7
    • @@ -45,22 +45,22 @@

    Properties

    bootstrap

    bootstrap: LifeCycleFn<AppOrParcelProps> | LifeCycleFn<AppOrParcelProps>[]
    +
  • Defined in app/interfaces/LifeCycles.ts:10

    • mount

    mount: LifeCycleFn<AppOrParcelProps> | LifeCycleFn<AppOrParcelProps>[]
    +
  • Defined in app/interfaces/LifeCycles.ts:11

    • unmount

    unmount: LifeCycleFn<AppOrParcelProps> | LifeCycleFn<AppOrParcelProps>[]
    +
  • Defined in app/interfaces/LifeCycles.ts:12

    • Optional update

    update?: LifeCycleFn<AppOrParcelProps> | LifeCycleFn<AppOrParcelProps>[]
    +
  • Defined in app/interfaces/LifeCycles.ts:13
    • diff --git a/interfaces/app.ParcelMountProps.html b/interfaces/app.ParcelMountProps.html index 775d705..0aa5752 100644 --- a/interfaces/app.ParcelMountProps.html +++ b/interfaces/app.ParcelMountProps.html @@ -21,7 +21,7 @@

    Hierarchy

    • ParcelMountProps
    +
  • Defined in app/interfaces/ParcelMountProps.ts:3
    • @@ -38,12 +38,12 @@

    Properties

    domElement

    domElement: HTMLElement
    +
  • Defined in app/interfaces/ParcelMountProps.ts:4

    • Optional errorHandler

    errorHandler?: ErrorHandler
    +
  • Defined in app/interfaces/ParcelMountProps.ts:5
    • diff --git a/interfaces/app.ParcelObject.html b/interfaces/app.ParcelObject.html index ff4df1b..3094e76 100644 --- a/interfaces/app.ParcelObject.html +++ b/interfaces/app.ParcelObject.html @@ -30,7 +30,7 @@

    Hierarchy

    • ParcelObject
    +
  • Defined in app/interfaces/ParcelObject.ts:8
    • @@ -58,28 +58,28 @@

    bootstrapPromise

    Returns a promise that will resolve once the parcel has been bootstrapped.

    +
  • Defined in app/interfaces/ParcelObject.ts:40

    • loadPromise

    loadPromise: Promise<null>

    Returns a promise that will resolve once the parcel has been loaded.

    +
  • Defined in app/interfaces/ParcelObject.ts:36

    • mountPromise

    mountPromise: Promise<null>

    Returns a promise that will resolve once the parcel has been mounted. This is helpful for knowing exactly when a parcel has been appended to the DOM

    +
  • Defined in app/interfaces/ParcelObject.ts:44

    • unmountPromise

    unmountPromise: Promise<null>

    Returns a promise that will resolve once the parcel has been unmounted.

    +
  • Defined in app/interfaces/ParcelObject.ts:48

    • Methods

    @@ -91,7 +91,7 @@

    getStatus

    Returns AppStatus

    +
  • Defined in app/interfaces/ParcelObject.ts:31

    • mount

    +
  • Defined in app/interfaces/ParcelObject.ts:12

    • unmount

    +
  • Defined in app/interfaces/ParcelObject.ts:17

    • Optional update

      @@ -129,7 +129,7 @@

      Parameters

      customProps: ExtraProps

    Returns Promise<null>

    +
  • Defined in app/interfaces/ParcelObject.ts:26
    • diff --git a/interfaces/app.ParcelSdk.html b/interfaces/app.ParcelSdk.html index 4100765..8e8eb19 100644 --- a/interfaces/app.ParcelSdk.html +++ b/interfaces/app.ParcelSdk.html @@ -29,7 +29,7 @@

    Hierarchy

    • ParcelSdk
    +
  • Defined in app/interfaces/ParcelSdk.ts:6
    • @@ -47,19 +47,19 @@

    Properties

    intl

    intl: IlcIntl
    +
  • Defined in app/interfaces/ParcelSdk.ts:9

    • parcelId

    parcelId: string

    Unique parcel ID, if same parcel will be rendered twice on a page - they will get different IDs

    +
  • Defined in app/interfaces/ParcelSdk.ts:8

    • registryProps

    registryProps: RegProps
    +
  • Defined in app/interfaces/ParcelSdk.ts:10
    • diff --git a/interfaces/app.SingleSpaLifecycleFnProps.html b/interfaces/app.SingleSpaLifecycleFnProps.html index 9558698..4b37bd9 100644 --- a/interfaces/app.SingleSpaLifecycleFnProps.html +++ b/interfaces/app.SingleSpaLifecycleFnProps.html @@ -24,7 +24,7 @@

    Hierarchy

  • AppLifecycleFnProps
  • ParcelLifecycleFnPropsSystem
    • +
  • Defined in app/interfaces/SingleSpaLifecycleFnProps.ts:3
    • @@ -44,14 +44,14 @@

    mountParcelmountParcel will be automatically unmounted when the application is unmounted.

    +
  • Defined in app/interfaces/SingleSpaLifecycleFnProps.ts:11

    • name

    name: string

    Unique application ID, if same app will be rendered twice on a page - it will get different IDs

    +
  • Defined in app/interfaces/SingleSpaLifecycleFnProps.ts:5
    • diff --git a/interfaces/app._internal_.CustomProps.html b/interfaces/app._internal_.CustomProps.html index 1fe342e..bdf9017 100644 --- a/interfaces/app._internal_.CustomProps.html +++ b/interfaces/app._internal_.CustomProps.html @@ -25,7 +25,7 @@

    Hierarchy

    Indexable

    [str: string]: any
    +
  • Defined in app/interfaces/CustomProps.ts:1
    • diff --git a/interfaces/app._internal_.OptionsIntl.html b/interfaces/app._internal_.OptionsIntl.html index f252221..6a0a236 100644 --- a/interfaces/app._internal_.OptionsIntl.html +++ b/interfaces/app._internal_.OptionsIntl.html @@ -22,7 +22,7 @@

    Hierarchy

    • OptionsIntl
    +
  • Defined in app/interfaces/OptionsSdk.ts:6
    • @@ -38,7 +38,7 @@

    Properties

    manifestPath

    manifestPath: string
    +
  • Defined in app/interfaces/OptionsSdk.ts:7
    • diff --git a/interfaces/app._internal_.OptionsSdk.html b/interfaces/app._internal_.OptionsSdk.html index 284f85f..81fdd0b 100644 --- a/interfaces/app._internal_.OptionsSdk.html +++ b/interfaces/app._internal_.OptionsSdk.html @@ -22,7 +22,7 @@

    Hierarchy

    • OptionsSdk
    +
  • Defined in app/interfaces/OptionsSdk.ts:1
    • @@ -39,12 +39,12 @@

    Properties

    Optional cssBundle

    cssBundle?: string
    +
  • Defined in app/interfaces/OptionsSdk.ts:3

    • Optional i18n

    i18n?: OptionsIntl
    +
  • Defined in app/interfaces/OptionsSdk.ts:2
    • diff --git a/interfaces/app._internal_.ParcelLifecycleFnPropsSystem.html b/interfaces/app._internal_.ParcelLifecycleFnPropsSystem.html index 2777b16..80e3730 100644 --- a/interfaces/app._internal_.ParcelLifecycleFnPropsSystem.html +++ b/interfaces/app._internal_.ParcelLifecycleFnPropsSystem.html @@ -29,7 +29,7 @@

    Hierarchy

    • ParcelLifecycleFnPropsSystem
    +
  • Defined in app/interfaces/ParcelLifecycleFnProps.ts:5
    • @@ -52,7 +52,7 @@

    mountParcel

    +
  • Defined in app/interfaces/SingleSpaLifecycleFnProps.ts:11

    • name

    name: string
    @@ -60,12 +60,12 @@

    name

    Inherited from SingleSpaLifecycleFnProps.name

    +
  • Defined in app/interfaces/SingleSpaLifecycleFnProps.ts:5

    • parcelSdk

    parcelSdk: ParcelSdk<RegProps>
    +
  • Defined in app/interfaces/ParcelLifecycleFnProps.ts:6

    • unmountSelf

    unmountSelf: (() => Promise<null>)
    @@ -80,7 +80,7 @@

    Type declaration

    Returns Promise<null>

    +
  • Defined in app/interfaces/ParcelLifecycleFnProps.ts:9
    • diff --git a/interfaces/server.AppAssets.html b/interfaces/server.AppAssets.html index 01b2308..310a9ed 100644 --- a/interfaces/server.AppAssets.html +++ b/interfaces/server.AppAssets.html @@ -29,7 +29,7 @@

    Hierarchy

    • AppAssets
    +
  • Defined in server/types.ts:27
    • @@ -49,7 +49,7 @@

    Optional

    URL to the CSS application file

    +
  • Defined in server/types.ts:31

    • Optional dependencies

    dependencies?: {
        [key: string]: string;
    }
    @@ -61,14 +61,14 @@

    Type declaration

  • [key: string]: string
    • +
  • Defined in server/types.ts:33

    • spaBundle

    spaBundle: string

    URL to the JS application bundle

    +
  • Defined in server/types.ts:29
    • diff --git a/interfaces/server.FactoryConfig.html b/interfaces/server.FactoryConfig.html index 63a7038..5ed1cb3 100644 --- a/interfaces/server.FactoryConfig.html +++ b/interfaces/server.FactoryConfig.html @@ -21,7 +21,7 @@

    Hierarchy

    • FactoryConfig
    +
  • Defined in server/types.ts:52
    • @@ -38,7 +38,7 @@

    Properties

    Optional jsFilesTest

    jsFilesTest?: RegExp
    +
  • Defined in server/types.ts:53

    • Optional publicPathDetection

    publicPathDetection?: {
        disable?: boolean;
        rootDirectoryLevel?: number;
        ssrPublicPath?: string;
    }
    @@ -58,7 +58,7 @@
    Optional ssrPublicP

    Default value: ${process.env.ILC_APP_PUBLIC_PATH}

    +
  • Defined in server/types.ts:54
    • diff --git a/interfaces/server.Logger.html b/interfaces/server.Logger.html index 45ef732..ede70e1 100644 --- a/interfaces/server.Logger.html +++ b/interfaces/server.Logger.html @@ -21,7 +21,7 @@

    Hierarchy

    • Logger
    +
  • Defined in server/types.ts:71
    • @@ -48,7 +48,7 @@

    Parameters

    logInfo: string | Record<string, any>

    Returns void

    +
  • Defined in server/types.ts:74

    • error

      @@ -61,7 +61,7 @@

      Parameters

      logInfo: string | Record<string, any>

    Returns void

    +
  • Defined in server/types.ts:75

    • info

    Returns void

    +
  • Defined in server/types.ts:72

    • warn

    Returns void

    +
  • Defined in server/types.ts:73
    • diff --git a/interfaces/server.RequestData.html b/interfaces/server.RequestData.html index 543e940..d686735 100644 --- a/interfaces/server.RequestData.html +++ b/interfaces/server.RequestData.html @@ -31,7 +31,7 @@

    Hierarchy

    • RequestData
    +
  • Defined in server/types.ts:6
    • @@ -58,7 +58,7 @@

    appId

    +
  • Defined in app/interfaces/common.ts:28

    • getCurrentBasePath

    getCurrentBasePath: (() => string)
    @@ -73,7 +73,7 @@

    Type declaration

    Returns string

    +
  • Defined in server/types.ts:11

    • getCurrentPathProps

    getCurrentPathProps: (() => RegistryProps)
    @@ -88,7 +88,7 @@

    Type declaration

    Returns RegistryProps

    +
  • Defined in server/types.ts:17

    • getCurrentReqHost

    getCurrentReqHost: (() => string)
    @@ -101,7 +101,7 @@

    Type declaration

  • Returns string

    • +
  • Defined in server/types.ts:7

    • getCurrentReqOriginalUri

    getCurrentReqOriginalUri: (() => string)
    @@ -116,7 +116,7 @@

    Type declaration

    Returns string

    +
  • Defined in server/types.ts:13

    • getCurrentReqUrl

    getCurrentReqUrl: (() => string)
    @@ -131,7 +131,7 @@

    Type declaration

    Returns string

    +
  • Defined in server/types.ts:9

    • getWrappedAppProps

    getWrappedAppProps: (() => RegistryProps)
    @@ -146,13 +146,13 @@

    Type declaration

    Returns RegistryProps

    +
  • Defined in server/types.ts:15

    • intl

    intl: IntlAdapter
    +
  • Defined in server/types.ts:18

    • trigger404Page

    trigger404Page: ((withCustomContent?: boolean) => void)
    @@ -171,7 +171,7 @@
    Optional withCustomContent: Returns void
    +
  • Defined in app/interfaces/common.ts:30
    • diff --git a/interfaces/server.ResponseData.html b/interfaces/server.ResponseData.html index d5fc9bb..c8ce8cf 100644 --- a/interfaces/server.ResponseData.html +++ b/interfaces/server.ResponseData.html @@ -24,7 +24,7 @@

    Hierarchy

    • ResponseData
    +
  • Defined in server/types.ts:39
    • @@ -42,21 +42,21 @@

    Properties

    Optional appAssets

    appAssets?: AppAssets
    +
  • Defined in server/types.ts:40

    • Optional pageMetaTags

    pageMetaTags?: string

    Meta tags list in a form of HTML string that should be applied to the page. Works only for primary applications.

    +
  • Defined in server/types.ts:44

    • Optional pageTitle

    pageTitle?: string

    Title that should be applied to the page. Works only for primary applications.

    +
  • Defined in server/types.ts:42
    • diff --git a/interfaces/server.WrapperResponseData.html b/interfaces/server.WrapperResponseData.html index 1f6702e..89ff61d 100644 --- a/interfaces/server.WrapperResponseData.html +++ b/interfaces/server.WrapperResponseData.html @@ -21,7 +21,7 @@

    Hierarchy

    • WrapperResponseData
    +
  • Defined in server/types.ts:47
    • @@ -44,7 +44,7 @@

    Type declaration

  • [key: string]: any
    • +
  • Defined in server/types.ts:49
    • diff --git a/interfaces/server._internal_.IlcSdkLogger.html b/interfaces/server._internal_.IlcSdkLogger.html index 8a68091..b4ecd3f 100644 --- a/interfaces/server._internal_.IlcSdkLogger.html +++ b/interfaces/server._internal_.IlcSdkLogger.html @@ -26,7 +26,7 @@

    Hierarchy

    • IlcSdkLogger
    +
  • Defined in server/IlcSdkLogger.ts:5
    • @@ -53,7 +53,7 @@
    message: string
    Optional error: Error

    Returns void

    +
  • Defined in server/IlcSdkLogger.ts:8

    • warn

      @@ -68,7 +68,7 @@
      message: string
      Optional error: Error

    Returns void

    +
  • Defined in server/IlcSdkLogger.ts:6
    • diff --git a/interfaces/server._internal_.ProcessedRequest.html b/interfaces/server._internal_.ProcessedRequest.html index 2258bb5..229e4a1 100644 --- a/interfaces/server._internal_.ProcessedRequest.html +++ b/interfaces/server._internal_.ProcessedRequest.html @@ -27,7 +27,7 @@

    Hierarchy

    • ProcessedRequest
    +
  • Defined in server/interfaces/ProcessedRequest.ts:5
    • @@ -45,7 +45,7 @@

    Properties

    appSdk

    appSdk: IlcAppSdk
    +
  • Defined in server/interfaces/ProcessedRequest.ts:7

    • processResponse

    processResponse: ((res: ServerResponse<IncomingMessage>, data?: ResponseData) => void)
    @@ -65,12 +65,12 @@
    res: ServerResponseOptional data: ResponseData

    Returns void

    +
  • Defined in server/interfaces/ProcessedRequest.ts:8

    • requestData

    requestData: RequestData<RegistryProps>
    +
  • Defined in server/interfaces/ProcessedRequest.ts:6
    • diff --git a/modules/app.html b/modules/app.html index 4e68ecf..4ee0211 100644 --- a/modules/app.html +++ b/modules/app.html @@ -38,7 +38,7 @@

    Example

    const
    +
  • Defined in app/index.ts:40
    • diff --git a/modules/server.html b/modules/server.html index 95554e6..aa6b16e 100644 --- a/modules/server.html +++ b/modules/server.html @@ -46,7 +46,7 @@

    Example

    Vue.js sample
    +
  • Defined in server/index.ts:75
    • diff --git a/types/app.AppStatus.html b/types/app.AppStatus.html index 07e28a5..5a86909 100644 --- a/types/app.AppStatus.html +++ b/types/app.AppStatus.html @@ -18,7 +18,7 @@

    Type alias AppStatus

    AppStatus: "NOT_LOADED" | "LOADING_SOURCE_CODE" | "NOT_BOOTSTRAPPED" | "BOOTSTRAPPING" | "NOT_MOUNTED" | "MOUNTING" | "MOUNTED" | "UPDATING" | "UNMOUNTING" | "UNLOADING" | "SKIP_BECAUSE_BROKEN" | "LOAD_ERROR"
    +
  • Defined in app/interfaces/AppStatus.ts:1
    • diff --git a/types/app.ErrorHandler.html b/types/app.ErrorHandler.html index 5aa62ae..71efc4c 100644 --- a/types/app.ErrorHandler.html +++ b/types/app.ErrorHandler.html @@ -37,7 +37,7 @@
    error: Error
    Optional errorInfo: Record<string, any>

    Returns void

    +
  • Defined in app/interfaces/ErrorHandler.ts:6
    • diff --git a/types/app.LifeCycleFn.html b/types/app.LifeCycleFn.html index ba7a99e..4367a45 100644 --- a/types/app.LifeCycleFn.html +++ b/types/app.LifeCycleFn.html @@ -36,7 +36,7 @@

    Parameters

    config: AppOrParcelProps

    Returns Promise<any>

    +
  • Defined in app/interfaces/LifeCycles.ts:5
    • diff --git a/types/app.MountParcel.html b/types/app.MountParcel.html index 003e8e3..be9956c 100644 --- a/types/app.MountParcel.html +++ b/types/app.MountParcel.html @@ -38,7 +38,7 @@
    parcelConfig: customProps: ParcelMountProps & ExtraProps

    Returns ParcelObject<ExtraProps>

    +
  • Defined in app/interfaces/MountParcel.ts:5
    • diff --git a/types/app.ParcelConfig.html b/types/app.ParcelConfig.html index 493f38f..27d683e 100644 --- a/types/app.ParcelConfig.html +++ b/types/app.ParcelConfig.html @@ -23,7 +23,7 @@

    Type Parameters

  • ExtraProps = CustomProps

    • +
  • Defined in app/interfaces/ParcelConfig.ts:5
    • diff --git a/types/app.ParcelLifecycleFnProps.html b/types/app.ParcelLifecycleFnProps.html index 6f524c3..fcb20a3 100644 --- a/types/app.ParcelLifecycleFnProps.html +++ b/types/app.ParcelLifecycleFnProps.html @@ -27,7 +27,7 @@

    ExtraProps = {}

  • RegProps = unknown

    • +
  • Defined in app/interfaces/ParcelLifecycleFnProps.ts:15
    • diff --git a/types/app.Render404.html b/types/app.Render404.html index ac278fd..aac47d4 100644 --- a/types/app.Render404.html +++ b/types/app.Render404.html @@ -31,7 +31,7 @@

    Parameters

    Optional withCustomContent: boolean

    Returns void

    +
  • Defined in app/interfaces/common.ts:33
    • diff --git a/types/app._internal_.GetAllSharedLibNames.html b/types/app._internal_.GetAllSharedLibNames.html index ab8cac3..fcc6880 100644 --- a/types/app._internal_.GetAllSharedLibNames.html +++ b/types/app._internal_.GetAllSharedLibNames.html @@ -27,7 +27,7 @@

    Type declaration

  • Returns Promise<string[]>

    • +
  • Defined in app/interfaces/GetAllSharedLibNames.ts:1
    • diff --git a/types/server._internal_.DiscoveryMetadata.html b/types/server._internal_.DiscoveryMetadata.html index 7a85e58..82587eb 100644 --- a/types/server._internal_.DiscoveryMetadata.html +++ b/types/server._internal_.DiscoveryMetadata.html @@ -19,7 +19,7 @@

    Type alias DiscoveryMetadata

    DiscoveryMetadata: Record<string, string | number | boolean>
    +
  • Defined in server/RegistryApi.ts:6
    • diff --git a/types/server._internal_.ListDiscoveredApps.html b/types/server._internal_.ListDiscoveredApps.html index 9af668c..0befa36 100644 --- a/types/server._internal_.ListDiscoveredApps.html +++ b/types/server._internal_.ListDiscoveredApps.html @@ -19,7 +19,7 @@

    Type alias ListDiscoveredApps

    ListDiscoveredApps: {
        discoveryMetadata: DiscoveryMetadata;
        name: string;
    }[]
    +
  • Defined in server/RegistryApi.ts:8
    • diff --git a/types/server._internal_.Options.html b/types/server._internal_.Options.html index 9184fff..1d81efa 100644 --- a/types/server._internal_.Options.html +++ b/types/server._internal_.Options.html @@ -26,7 +26,7 @@
    Optional logger
    Optional maxAgeMillisecondsOfGetApps?: number
    +
  • Defined in server/RegistryApi.ts:13
    • diff --git a/types/server._internal_.SsrContext.html b/types/server._internal_.SsrContext.html index e2ee276..85f88d1 100644 --- a/types/server._internal_.SsrContext.html +++ b/types/server._internal_.SsrContext.html @@ -26,7 +26,7 @@
    Optional code
    Optional headers?: Record<string, string>
    +
  • Defined in server/interfaces/SsrContext.ts:1
    • diff --git a/variables/server.IlcProtocol.html b/variables/server.IlcProtocol.html index 83045cd..d088185 100644 --- a/variables/server.IlcProtocol.html +++ b/variables/server.IlcProtocol.html @@ -18,7 +18,7 @@

    Variable IlcProtocolConst

    IlcProtocol: Type = ...
    +
  • Defined in server/IlcProtocol.ts:4