Socket
Socket
Sign inDemoInstall

@mfng/core

Package Overview
Dependencies
8
Maintainers
1
Versions
11
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @mfng/core

Core server and client utilities for bootstrapping a React Server Components app


Version published
Weekly downloads
5
decreased by-93.51%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

@mfng/core

⚠️ Experimental

This package contains the essential building blocks required on both the server and the client to create a streaming, server-side rendered, and properly hydrated RSC app. It also provides utilities needed for server-centric, client-side navigation.

Getting Started

To use this library in your React Server Components project, follow these high-level steps:

  1. Install the library along with React Canary:
npm install @mfng/core react@canary react-dom@canary react-server-dom-webpack@canary
  1. Create a server entry that handles GET requests to create RSC app streams and HTML streams, as well as POST requests for creating RSC action streams. Optionally, add support for progressively enhanced forms.

  2. Create a client entry that hydrates the server-rendered app and fetches RSC streams during navigation or when executing server actions.

  3. Set up your webpack config as described in the @mfng/webpack-rsc README.

  4. Create a simple dev server using Hono and tsx.

Building Blocks

Server

@mfng/core/server/rsc
  • createRscAppStream
  • createRscActionStream
  • createRscFormState
@mfng/core/server/ssr
  • createHtmlStream
@mfng/core/router-location-async-local-storage
  • routerLocationAsyncLocalStorage

Client

@mfng/core/client/browser
  • hydrateApp
  • callServer (usually not directly needed, encapsulated by hydrateApp)
  • Router (usually not directly needed, encapsulated by hydrateApp)
@mfng/core/client
  • useRouter
  • Link
  • CallServerError

Universal (Client & Server)

@mfng/core/use-router-location
  • useRouterLocation

Putting It All Together

I would recommend taking a look at the example apps. The AWS app has a particularly clean setup.

FAQs

Last updated on 06 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc