Add documentation for the param parameter of z.custom

colinhacks · Feb 18, 2023 · 5cec187 · 5cec187
1 parent 9b7dd81
commit 5cec187
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1714,6 +1714,12 @@ If you don't provide a validation function, Zod will allow any value. This can b
 z.custom<{ arg: string }>(); // performs no validation
 ```
 
+You can customize the error message and other options by passing a second argument. This parameter works the same way as the params parameter of [`.refine`](#refine).
+
+```ts
+z.custom<...>((val) => ..., "custom error message");
+```
+
 ## Schema methods
 
 All Zod schemas contain certain methods.