Skip to content

Commit 79abcff

Browse files
authored
docs(website-new): add docs on __FEDERATION__ (#3624) (#3625)
1 parent a753735 commit 79abcff

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

apps/website-new/docs/en/guide/debug/variables.mdx

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -892,4 +892,47 @@ Looking at the `useIn` field, you can see that the `useIn` field contains the `w
892892

893893
### __INSTANCES__
894894

895-
The currently loaded MF instance.
895+
The currently loaded MF instance. It stores a list of all loaded MF modules. Every list entry has the following structure:
896+
897+
#### bridgeHook
898+
Contains metadata about the MF bridge which is used to enable cross-application use-cases (React, Vue) to load properly.
899+
900+
#### hooks
901+
Contains metadata about the MF hooks which are used to tap into the MF lifecycle.
902+
903+
#### loaderHook
904+
Contains metadata about the MF loaderHook.
905+
906+
#### moduleCache
907+
Contains a Map storing all MF modules with their metadata available in the moduleCache.
908+
909+
#### name
910+
The name of the MF module.
911+
912+
#### options
913+
> Useful for debugging your modules.
914+
915+
Vital data about the MF module, such as loaded plugins, connected remotes, shareStrategy and the shared dependency object.
916+
917+
#### remoteHandler
918+
Contains metadata about the MF remoteHandler including the idToRemoteMap which stores all bindings to connected remote components exposed by the connected MF remotes.
919+
920+
#### shareScopeMap
921+
Contains metadata about the MF shared scope including data about every connected shared dependency.
922+
923+
#### sharedHandler
924+
Contains metadata about the MF sharedHandler.
925+
926+
#### snapshotHandler
927+
> Useful to check the mf-manifest.json structure and status.
928+
929+
Contains metadata about the MF snapshotHandler including the manifestCache object and the manifestLoading object.
930+
931+
#### version
932+
The version of the Mf module.
933+
934+
### __PRELOADED_MAP__
935+
The key-value-map of all preloaded modules (build-time). `key` represents the module name, and `value` represents the boolean value of the loaded status.
936+
937+
### __MANIFEST_LOADING__
938+
Contains metadata about the manifestLoading object. This is the same as the `snapshotHandler.manifestLoading` in `__INSTANCES__`.

0 commit comments

Comments
 (0)