@apollo/client-react-streaming - npm Package Compare versions

Comparing version 0.11.1 to 0.11.2

dist/combined.d.ts

@@ -98,5 +98,48 @@ import * as _apollo_client_index_js from '@apollo/client/index.js';
 };
+/**
+ * Props for `PreloadQueryComponent`
+ * @see {@link PreloadQueryComponent}
+ * @public
+ */
 interface PreloadQueryProps<TData, TVariables> extends PreloadQueryOptions<TVariables, TData> {
     children: ReactNode | ((queryRef: TransportedQueryRef<NoInfer<TData>, NoInfer<TVariables>>) => ReactNode);
 }
+/**
+ * Preloads data in React Server Components to be hydrated
+ * in Client Components.
+ *
+ * ### Example with `queryRef`
+ * `ClientChild` would call `useReadQuery` with the `queryRef`, the `Suspense` boundary is optional:
+ * ```jsx
+ * <PreloadQuery
+ *    query={QUERY}
+ *    variables={{
+ *      foo: 1
+ *    }}
+ *  >
+ *   {(queryRef) => (
+ *     <Suspense fallback={<>loading</>}>
+ *       <ClientChild queryRef={queryRef} />
+ *     </Suspense>
+ *   )}
+ * </PreloadQuery>
+ * ```
+ *
+ * ### Example for `useSuspenseQuery`
+ * `ClientChild` would call the same query with `useSuspenseQuery`, the `Suspense` boundary is optional:
+ * ```jsx
+ *  <PreloadQuery
+ *    query={QUERY}
+ *    variables={{
+ *      foo: 1
+ *    }}
+ *  >
+ *    <Suspense fallback={<>loading</>}>
+ *      <ClientChild />
+ *    </Suspense>
+ *  </PreloadQuery>
+ * ```
+ *
+ * @public
+ */
 interface PreloadQueryComponent {
@@ -498,2 +541,2 @@ <TData, TVariables extends OperationVariables>(props: PreloadQueryProps<TData, TVariables>): React.ReactElement;
 
-export { ApolloClient, DataTransportContext, type DataTransportProviderImplementation, AccumulateMultipartResponsesLink as DebounceMultipartResponsesLink, InMemoryCache, type QueryEvent, RemoveMultipartDirectivesLink, SSRMultipartLink, type TransportedQueryRef, WrapApolloProvider, type WrappedApolloProvider, registerApolloClient, resetApolloSingletons };
+export { ApolloClient, DataTransportContext, type DataTransportProviderImplementation, AccumulateMultipartResponsesLink as DebounceMultipartResponsesLink, InMemoryCache, type PreloadQueryComponent, type PreloadQueryProps, type QueryEvent, RemoveMultipartDirectivesLink, SSRMultipartLink, type TransportedQueryRef, WrapApolloProvider, type WrappedApolloProvider, registerApolloClient, resetApolloSingletons };

dist/index.rsc.d.ts

@@ -98,5 +98,48 @@ import * as _apollo_client_index_js from '@apollo/client/index.js';
 };
+/**
+ * Props for `PreloadQueryComponent`
+ * @see {@link PreloadQueryComponent}
+ * @public
+ */
 interface PreloadQueryProps<TData, TVariables> extends PreloadQueryOptions<TVariables, TData> {
     children: ReactNode | ((queryRef: TransportedQueryRef<NoInfer<TData>, NoInfer<TVariables>>) => ReactNode);
 }
+/**
+ * Preloads data in React Server Components to be hydrated
+ * in Client Components.
+ *
+ * ### Example with `queryRef`
+ * `ClientChild` would call `useReadQuery` with the `queryRef`, the `Suspense` boundary is optional:
+ * ```jsx
+ * <PreloadQuery
+ *    query={QUERY}
+ *    variables={{
+ *      foo: 1
+ *    }}
+ *  >
+ *   {(queryRef) => (
+ *     <Suspense fallback={<>loading</>}>
+ *       <ClientChild queryRef={queryRef} />
+ *     </Suspense>
+ *   )}
+ * </PreloadQuery>
+ * ```
+ *
+ * ### Example for `useSuspenseQuery`
+ * `ClientChild` would call the same query with `useSuspenseQuery`, the `Suspense` boundary is optional:
+ * ```jsx
+ *  <PreloadQuery
+ *    query={QUERY}
+ *    variables={{
+ *      foo: 1
+ *    }}
+ *  >
+ *    <Suspense fallback={<>loading</>}>
+ *      <ClientChild />
+ *    </Suspense>
+ *  </PreloadQuery>
+ * ```
+ *
+ * @public
+ */
 interface PreloadQueryComponent {
@@ -405,2 +448,2 @@ <TData, TVariables extends OperationVariables>(props: PreloadQueryProps<TData, TVariables>): React.ReactElement;
 
-export { ApolloClient, AccumulateMultipartResponsesLink as DebounceMultipartResponsesLink, InMemoryCache, RemoveMultipartDirectivesLink, SSRMultipartLink, type TransportedQueryRef, registerApolloClient };
+export { ApolloClient, AccumulateMultipartResponsesLink as DebounceMultipartResponsesLink, InMemoryCache, type PreloadQueryComponent, type PreloadQueryProps, RemoveMultipartDirectivesLink, SSRMultipartLink, type TransportedQueryRef, registerApolloClient };

package.json

 {
   "name": "@apollo/client-react-streaming",
-  "version": "0.11.1",
+  "version": "0.11.2",
   "repository": {
@@ -5,0 +5,0 @@ "url": "git+https://github.com/apollographql/apollo-client-nextjs"

No alert changes

Improved metrics

Total package byte prevSize

1173338

increased by0.51%

Lines of code

10331

increased by0.84%

No dependency changes