Skip to content

docs: add runtime api and runtime hooks part#4658

Merged
2heal1 merged 1 commit intomainfrom
docs/runtime-hook
Apr 14, 2026
Merged

docs: add runtime api and runtime hooks part#4658
2heal1 merged 1 commit intomainfrom
docs/runtime-hook

Conversation

@2heal1
Copy link
Copy Markdown
Member

@2heal1 2heal1 commented Apr 14, 2026

Description

add runtime api and runtime hooks part

Related Issue

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have updated the documentation.

@netlify
Copy link
Copy Markdown

netlify bot commented Apr 14, 2026

Deploy Preview for module-federation-docs ready!

Name Link
🔨 Latest commit 1d1477a
🔍 Latest deploy log https://app.netlify.com/projects/module-federation-docs/deploys/69ddf45b69f0a70008ea0790
😎 Deploy Preview https://deploy-preview-4658--module-federation-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 14, 2026

⚠️ No Changeset found

Latest commit: 1d1477a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Apr 14, 2026

Open in StackBlitz

@module-federation/devtools

pnpm add https://pkg.pr.new/@module-federation/devtools@4658

@module-federation/cli

pnpm add https://pkg.pr.new/@module-federation/cli@4658

create-module-federation

pnpm add https://pkg.pr.new/create-module-federation@4658

@module-federation/data-prefetch

pnpm add https://pkg.pr.new/@module-federation/data-prefetch@4658

@module-federation/dts-plugin

pnpm add https://pkg.pr.new/@module-federation/dts-plugin@4658

@module-federation/enhanced

pnpm add https://pkg.pr.new/@module-federation/enhanced@4658

@module-federation/error-codes

pnpm add https://pkg.pr.new/@module-federation/error-codes@4658

@module-federation/esbuild

pnpm add https://pkg.pr.new/@module-federation/esbuild@4658

@module-federation/managers

pnpm add https://pkg.pr.new/@module-federation/managers@4658

@module-federation/manifest

pnpm add https://pkg.pr.new/@module-federation/manifest@4658

@module-federation/metro

pnpm add https://pkg.pr.new/@module-federation/metro@4658

@module-federation/metro-plugin-rnc-cli

pnpm add https://pkg.pr.new/@module-federation/metro-plugin-rnc-cli@4658

@module-federation/metro-plugin-rnef

pnpm add https://pkg.pr.new/@module-federation/metro-plugin-rnef@4658

@module-federation/modern-js

pnpm add https://pkg.pr.new/@module-federation/modern-js@4658

@module-federation/modern-js-v3

pnpm add https://pkg.pr.new/@module-federation/modern-js-v3@4658

@module-federation/native-federation-tests

pnpm add https://pkg.pr.new/@module-federation/native-federation-tests@4658

@module-federation/native-federation-typescript

pnpm add https://pkg.pr.new/@module-federation/native-federation-typescript@4658

@module-federation/nextjs-mf

pnpm add https://pkg.pr.new/@module-federation/nextjs-mf@4658

@module-federation/node

pnpm add https://pkg.pr.new/@module-federation/node@4658

@module-federation/retry-plugin

pnpm add https://pkg.pr.new/@module-federation/retry-plugin@4658

@module-federation/rsbuild-plugin

pnpm add https://pkg.pr.new/@module-federation/rsbuild-plugin@4658

@module-federation/rspack

pnpm add https://pkg.pr.new/@module-federation/rspack@4658

@module-federation/rspress-plugin

pnpm add https://pkg.pr.new/@module-federation/rspress-plugin@4658

@module-federation/runtime

pnpm add https://pkg.pr.new/@module-federation/runtime@4658

@module-federation/runtime-core

pnpm add https://pkg.pr.new/@module-federation/runtime-core@4658

@module-federation/runtime-tools

pnpm add https://pkg.pr.new/@module-federation/runtime-tools@4658

@module-federation/sdk

pnpm add https://pkg.pr.new/@module-federation/sdk@4658

@module-federation/storybook-addon

pnpm add https://pkg.pr.new/@module-federation/storybook-addon@4658

@module-federation/third-party-dts-extractor

pnpm add https://pkg.pr.new/@module-federation/third-party-dts-extractor@4658

@module-federation/treeshake-frontend

pnpm add https://pkg.pr.new/@module-federation/treeshake-frontend@4658

@module-federation/treeshake-server

pnpm add https://pkg.pr.new/@module-federation/treeshake-server@4658

@module-federation/typescript

pnpm add https://pkg.pr.new/@module-federation/typescript@4658

@module-federation/utilities

pnpm add https://pkg.pr.new/@module-federation/utilities@4658

@module-federation/webpack-bundler-runtime

pnpm add https://pkg.pr.new/@module-federation/webpack-bundler-runtime@4658

@module-federation/bridge-react

pnpm add https://pkg.pr.new/@module-federation/bridge-react@4658

@module-federation/bridge-react-webpack-plugin

pnpm add https://pkg.pr.new/@module-federation/bridge-react-webpack-plugin@4658

@module-federation/bridge-shared

pnpm add https://pkg.pr.new/@module-federation/bridge-shared@4658

@module-federation/bridge-vue3

pnpm add https://pkg.pr.new/@module-federation/bridge-vue3@4658

@module-federation/inject-external-runtime-core-plugin

pnpm add https://pkg.pr.new/@module-federation/inject-external-runtime-core-plugin@4658

commit: 1d1477a

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment on lines +41 to +45
## 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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@2heal1 2heal1 merged commit f13bac2 into main Apr 14, 2026
27 checks passed
@2heal1 2heal1 deleted the docs/runtime-hook branch April 14, 2026 08:20
@2heal1 2heal1 mentioned this pull request Apr 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant