isValid

.changeset/stupid-wasps-push.md

@@ -0,0 +1,5 @@
+---
+"next-typesafe-url": patch
+---
+
+feat: added isValid flag to prevent need to check isReady && !isError

README.md

@@ -160,14 +160,23 @@ $path({ path: "/" searchParams: { foo: undefined, bar: true } }) // => "/?bar=tr
 
 ```tsx
 const params = useSearchParams(Route.searchParams);
-const { data, isReady, isError, error } = params;
-
-// if isReady is true, and isError is false, then data will be in the shape of Route.searchParams
+const { 
+  data, 
+  isValid, 
+  isReady, 
+  isError, 
+  error 
+} = params;
+
+// if isReady is true, and isError is false (isValid is true), then data *will* be in the shape of Route.searchParams
 // in this case, data will be { userInfo: { name: string, age: number } }
 
-if (isError) {
-  return <div>Invalid search params</div>;
+if (!isReady) {
+  return <div>loading...</div>;
+} else if (isError) {
+  return <div>Invalid search params {error.message}</div>;
 } else {
+  // isValid === true
   return <div>{data.userInfo.name}</div>;
 }
 ```
@@ -176,6 +185,8 @@ if (isError) {
 
 **If `isReady` is true and `isError` is false, then `data` will always be valid and match the schema.**
 
+*For convenience, instead of needing checking `isReady && !isError`, I have added the `isValid` flag which is only true when `isReady` is `true` and and `isError` is false.*
+
 ## Reccomended Usage
 
 **It is reccomended to only call `useSearchParams` and `useRouteParams` in the top level component of each route, and pass the data down to child components through props or context.**

src/generateTypes.ts

@@ -143,18 +143,21 @@ declare function useSearchParams<T extends z.AnyZodObject>(
 type UseParamsResult<T extends z.AnyZodObject> =
   | {
       data: z.infer<T>;
+      isValid: true;
       isReady: true;
       isError: false;
       error: undefined;
     }
   | {
       data: undefined;
+      isValid: false;
       isReady: true;
       isError: true;
       error: z.ZodError<T>;
     }
   | {
       data: undefined;
+      isValid: false;
       isReady: false;
       isError: false;
       error: undefined;

src/index.ts

@@ -57,12 +57,13 @@ export function useRouteParams<T extends z.AnyZodObject>(
   }, [router, validator]);
 
   if (isError && isReady) {
-    return { data: undefined, isReady: true, isError: true, error: error };
+    return { data: undefined, isValid: false, isReady: true, isError: true, error: error };
   } else if (data !== undefined && isReady) {
-    return { data: data, isReady: true, isError: false, error: undefined };
+    return { data: data, isValid: true, isReady: true, isError: false, error: undefined };
   } else {
     return {
       data: undefined,
+      isValid: false,
       isReady: false,
       isError: false,
       error: undefined,
@@ -99,12 +100,13 @@ export function useSearchParams<T extends z.AnyZodObject>(
   }, [router, searchValidator]);
 
   if (isError && isReady) {
-    return { data: undefined, isReady: true, isError: true, error: error };
+    return { data: undefined, isValid: false, isReady: true, isError: true, error: error };
   } else if (data !== undefined && isReady) {
-    return { data: data, isReady: true, isError: false, error: undefined };
+    return { data: data, isValid: true, isReady: true, isError: false, error: undefined };
   } else {
     return {
       data: undefined,
+      isValid: false,
       isReady: false,
       isError: false,
       error: undefined,

src/types.d.ts

@@ -65,18 +65,21 @@ declare function useSearchParams<T extends z.AnyZodObject>(
 export type UseParamsResult<T extends z.AnyZodObject> =
   | {
       data: z.infer<T>;
+      isValid: true;
       isReady: true;
       isError: false;
       error: undefined;
     }
   | {
       data: undefined;
+      isValid: false;
       isReady: true;
       isError: true;
       error: z.ZodError<T>;
     }
   | {
       data: undefined;
+      isValid: false;
       isReady: false;
       isError: false;
       error: undefined;