Mreact Docs

Reference

@reckona/mreact-server/boundary

16 public exports.

Function

FunctionrenderAsyncBoundaryfunction renderAsyncBoundary<T>(sink: HtmlSink, value: T, render: AsyncBoundaryRender<T>, options: AsyncBoundaryOptions): Promise<void>Renders a value once it resolves, or renders a configured catch branch on error.FunctionrenderHydrationBoundaryfunction renderHydrationBoundary(sink: HtmlSink, id: string, render: (sink: HtmlSink): void | PromiseLike<void>): void | PromiseLike<void>Wraps server-rendered HTML in hydration start and end markers.FunctionrenderOutOfOrderBoundaryfunction renderOutOfOrderBoundary<T>(sink: HtmlSink, id: string, value: T, render: AsyncBoundaryRender<T>, options: OutOfOrderBoundaryOptions): voidEmits a placeholder immediately and defers resolved HTML as an out-of-order fragment.FunctionrenderOutOfOrderReorderScriptfunction renderOutOfOrderReorderScript(sink: HtmlSink, options: OutOfOrderReorderScriptOptions): voidEmits the client script that swaps out-of-order fragments into their placeholders.FunctionrenderReactSuspenseBoundaryfunction renderReactSuspenseBoundary(sink: HtmlSink, render: (sink: HtmlSink): void | PromiseLike<void>): void | PromiseLike<void>Wraps streamed content in React Suspense completion markers.FunctionrenderReactSuspenseClientRenderBoundaryfunction renderReactSuspenseClientRenderBoundary(sink: HtmlSink, fallback: (sink: HtmlSink): void | PromiseLike<void>, options: ReactSuspenseClientRenderOptions): void | PromiseLike<void>Emits a React Suspense boundary that instructs the client to render the fallback.FunctionrenderReactSuspenseOutOfOrderBoundaryfunction renderReactSuspenseOutOfOrderBoundary<T>(sink: HtmlSink, boundaryId: string, segmentId: string, value: T, render: AsyncBoundaryRender<T>, options: ReactSuspenseBoundaryOptions): voidEmits a React Suspense fallback and streams the resolved segment out of order.

Interface

InterfaceAsyncBoundaryOptionsinterface AsyncBoundaryOptionsOptions shared by async boundaries that render resolved values or caught errors.InterfaceHydrationScriptOptionsinterface HydrationScriptOptionsOptions for script tags that hydrate server-rendered data.InterfaceOutOfOrderBoundaryOptionsinterface OutOfOrderBoundaryOptionsOptions for rendering a boundary whose resolved content can arrive out of order.InterfaceOutOfOrderReorderScriptOptionsinterface OutOfOrderReorderScriptOptionsOptions for emitting the out-of-order fragment reorder script.InterfaceReactSuspenseBoundaryOptionsinterface ReactSuspenseBoundaryOptionsOptions for React Suspense boundaries rendered with streamed segments.InterfaceReactSuspenseClientRenderOptionsinterface ReactSuspenseClientRenderOptionsError metadata used when forcing a React Suspense boundary to client render.InterfaceReactSuspenseScriptOptionsinterface ReactSuspenseScriptOptionsOptions for scripts that reveal React Suspense segments.

Type Alias

Type AliasAsyncBoundaryRendertype AsyncBoundaryRender = (sink: HtmlSink, value: Awaited<T>): void | PromiseLike<void>Renderer invoked with an async boundary's resolved value.

Variable

VariablereactSuspenseRevealExternalScriptconst reactSuspenseRevealExternalScript: "(()=>{(self.$RC=self.$RC||function(bid,sid){var b=document.getElementById(bid);var s=document.getElementById(sid);if(!b||!s)return;var p=b.parentNode;var e=b.nextSibling;var d=0;var r=[];for(var n=e;n;n=n.nextSibling){if(n.nodeType===8){if(n.data===\"$\"||n.data===\"$?\"||n.data===\"$!\")d++;else if(n.data===\"/$\"){if(d===0){e=n;break;}d--;}}r.push(n);}for(var i=0;r[i];i++)p.removeChild(r[i]);while(s.firstChild)p.insertBefore(s.firstChild,e);s.remove();b.data=\"$\";});var s=document.currentScript;if(!s)return;var b=s.getAttribute(\"data-boundary-id\");var seg=s.getAttribute(\"data-segment-id\");if(b!==null&&seg!==null)self.$RC(b,seg);})();"External script body that reveals a React Suspense segment when loaded.