feat: make streamIsRequired public

vikejs · Jun 5, 2024 · 2829b15 · 2829b15
1 parent dc1ec7b
commit 2829b15
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/packages/vike-react-query/renderer/+config.ts b/packages/vike-react-query/renderer/+config.ts
@@ -7,7 +7,7 @@ export default {
   queryClientConfig: undefined,
   VikeReactQueryWrapper: 'import:vike-react-query/renderer/VikeReactQueryWrapper:default',
   FallbackErrorBoundary: 'import:vike-react-query/renderer/FallbackErrorBoundary:default',
-  _streamIsRequied: true,
+  streamIsRequired: true,
   meta: {
     queryClientConfig: {
       env: {

diff --git a/packages/vike-react/src/renderer/onRenderHtml.tsx b/packages/vike-react/src/renderer/onRenderHtml.tsx
@@ -38,12 +38,8 @@ const onRenderHtml: OnRenderHtmlAsync = async (pageContext): ReturnType<OnRender
     pageView = ''
   } else {
     const page = getPageElement(pageContext)
-    const {
-      stream,
-      // @ts-expect-error
-      _streamIsRequied
-    } = pageContext.config
-    if (!stream && !_streamIsRequied) {
+    const { stream, streamIsRequired } = pageContext.config
+    if (!stream && !streamIsRequired) {
       pageView = dangerouslySkipEscape(renderToString(page))
     } else {
       const disable = stream === false ? true : undefined

diff --git a/packages/vike-react/src/types/Config.ts b/packages/vike-react/src/types/Config.ts
@@ -62,6 +62,13 @@ declare global {
        */
       stream?: boolean
 
+      /**
+       * Whether the existence of the React SSR stream is required (some integrations require it).
+       *
+       * HTML Streaming can still be disabled: the SSR stream is awaited and converted to a string.
+       */
+      streamIsRequired?: boolean
+
       /**
        * Whether to use `<StrictMode>`.
        *