Update API reference of forward method on website

fabian-hiller · Jul 2, 2024 · 5c5aa81 · 5c5aa81
1 parent 07cf66b
commit 5c5aa81
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/website/src/routes/api/(methods)/forward/index.mdx b/website/src/routes/api/(methods)/forward/index.mdx
@@ -14,7 +14,7 @@ import { properties } from './properties';
 Forwards the issues of the passed validation action.
 
 ```ts
-const Action = v.forward<TInput, TIssue>(action, pathList);
+const Action = v.forward<TInput, TIssue>(action, pathKeys);
 ```
 
 ## Generics
@@ -25,11 +25,11 @@ const Action = v.forward<TInput, TIssue>(action, pathList);
 ## Parameters
 
 - `action` <Property {...properties.action} />
-- `pathList` <Property {...properties.pathList} />
+- `pathKeys` <Property {...properties.pathKeys} />
 
 ### Explanation
 
-`forward` allows you to forward the issues of the passed validation `action` via a `pathList` to a nested field of a schema.
+`forward` allows you to forward the issues of the passed validation `action` via `pathKeys` to a nested field of a schema.
 
 ## Returns
 

diff --git a/website/src/routes/api/(methods)/forward/properties.ts b/website/src/routes/api/(methods)/forward/properties.ts
@@ -12,8 +12,9 @@ export const properties: Record<string, PropertyProps> = {
  generics: ['string', 'unknown'],
  },
  {
- type: 'array',
- item: 'unknown',
+ type: 'custom',
+ name: 'ArrayLike',
+ generics: ['unknown'],
  },
  ],
  },
@@ -48,10 +49,11 @@ export const properties: Record<string, PropertyProps> = {
  ],
  },
  },
- pathList: {
+ pathKeys: {
  type: {
  type: 'custom',
- name: 'PathList',
+ name: 'PathKeys',
+ href: '../PathKeys/',
  generics: [
  {
  type: 'custom',