docs: add runtime api and runtime hooks part#4658
Conversation
✅ Deploy Preview for module-federation-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
@module-federation/devtools
@module-federation/cli
create-module-federation
@module-federation/data-prefetch
@module-federation/dts-plugin
@module-federation/enhanced
@module-federation/error-codes
@module-federation/esbuild
@module-federation/managers
@module-federation/manifest
@module-federation/metro
@module-federation/metro-plugin-rnc-cli
@module-federation/metro-plugin-rnef
@module-federation/modern-js
@module-federation/modern-js-v3
@module-federation/native-federation-tests
@module-federation/native-federation-typescript
@module-federation/nextjs-mf
@module-federation/node
@module-federation/retry-plugin
@module-federation/rsbuild-plugin
@module-federation/rspack
@module-federation/rspress-plugin
@module-federation/runtime
@module-federation/runtime-core
@module-federation/runtime-tools
@module-federation/sdk
@module-federation/storybook-addon
@module-federation/third-party-dts-extractor
@module-federation/treeshake-frontend
@module-federation/treeshake-server
@module-federation/typescript
@module-federation/utilities
@module-federation/webpack-bundler-runtime
@module-federation/bridge-react
@module-federation/bridge-react-webpack-plugin
@module-federation/bridge-shared
@module-federation/bridge-vue3
@module-federation/inject-external-runtime-core-plugin
commit: |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1d1477ade1
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ## init <Badge type='warning'>Use with caution</Badge> | ||
|
|
||
| :::warning Warning | ||
|
|
||
| This API will be deprecated. If you need to get an existing instance, you can use [getInstance](#getinstance) to retrieve the created instance. | ||
| `init` is still supported, but choose it based on how you want instances to be managed. |
There was a problem hiding this comment.
Mark
init as deprecated in runtime API docs
This change reclassifies init as merely “Use with caution,” but the exported API is still explicitly annotated @deprecated in packages/runtime/src/index.ts and editor/type tooling will continue to surface it as deprecated. Documenting it as non-deprecated creates conflicting guidance for users deciding between init and createInstance; please keep the docs aligned with the actual API status (or remove the deprecation annotation in code if that status changed).
Useful? React with 👍 / 👎.
Description
add runtime api and runtime hooks part
Related Issue
Types of changes
Checklist