Skip to content

feat: add skip to usePreloadedQuery #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add skip to usePreloadedQuery #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/react/hydration.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,19 @@ export type Preloaded<Query extends FunctionReference<"query">> = {
* Throws an error if not used under {@link ConvexProvider}.
*
* @param preloadedQuery - The `Preloaded` query payload from a Server Component.
* @param options - Options for the query, including whether to skip it.
* @returns the result of the query. Initially returns the result fetched
* by the Server Component. Subsequently returns the result fetched by the client.
* If the query is skipped, returns `undefined`.
*
* @public
*/
export function usePreloadedQuery<Query extends FunctionReference<"query">>(
preloadedQuery: Preloaded<Query>,
): Query["_returnType"] {
options?: { skip?: boolean },
): Query["_returnType"] | undefined {
const skip = options?.skip ?? false;

const args = useMemo(
() => jsonToConvex(preloadedQuery._argsJSON),
[preloadedQuery._argsJSON],
Expand All @@ -42,9 +47,10 @@ export function usePreloadedQuery<Query extends FunctionReference<"query">>(
() => jsonToConvex(preloadedQuery._valueJSON),
[preloadedQuery._valueJSON],
);

const result = useQuery(
makeFunctionReference(preloadedQuery._name) as Query,
args,
skip ? ("skip" as const) : args,
);
return result === undefined ? preloadedResult : result;
return skip ? undefined : result === undefined ? preloadedResult : result;
}