Update API reference of methods on website

fabian-hiller · May 25, 2024 · 51ce74d · 51ce74d
1 parent dda719c
commit 51ce74d
Show file tree

Hide file tree

Showing 30 changed files with 1,275 additions and 377 deletions.
diff --git a/library/src/methods/keyof/keyof.ts b/library/src/methods/keyof/keyof.ts
@@ -28,6 +28,11 @@ import type {
  * Schema type.
  */
 type Schema =
+  | LooseObjectSchema<ObjectEntries, ErrorMessage<LooseObjectIssue> | undefined>
+  | LooseObjectSchemaAsync<
+      ObjectEntriesAsync,
+      ErrorMessage<LooseObjectIssue> | undefined
+    >
   | ObjectSchema<ObjectEntries, ErrorMessage<ObjectIssue> | undefined>
   | ObjectSchemaAsync<ObjectEntriesAsync, ErrorMessage<ObjectIssue> | undefined>
   | ObjectWithRestSchema<
@@ -47,11 +52,6 @@ type Schema =
   | StrictObjectSchemaAsync<
       ObjectEntriesAsync,
       ErrorMessage<StrictObjectIssue> | undefined
-    >
-  | LooseObjectSchema<ObjectEntries, ErrorMessage<LooseObjectIssue> | undefined>
-  | LooseObjectSchemaAsync<
-      ObjectEntriesAsync,
-      ErrorMessage<LooseObjectIssue> | undefined
     >;
 
 /**

diff --git a/website/src/routes/api/(actions)/brand/index.mdx b/website/src/routes/api/(actions)/brand/index.mdx
@@ -113,7 +113,6 @@ The following APIs can be combined with `brand`.
     'getFallbacks',
     'is',
     'keyof',
-    'merge',
     'omit',
     'parse',
     'partial',

diff --git a/website/src/routes/api/(actions)/transform/index.mdx b/website/src/routes/api/(actions)/transform/index.mdx
@@ -134,7 +134,6 @@ The following APIs can be combined with `transform`.
     'getFallbacks',
     'is',
     'keyof',
-    'merge',
     'omit',
     'parse',
     'partial',

diff --git a/website/src/routes/api/(methods)/fallback/index.mdx b/website/src/routes/api/(methods)/fallback/index.mdx
@@ -1,6 +1,7 @@
 ---
 title: fallback
-description: Returns a fallback output value when validating the passed schema failed.
+description: >-
+  Returns a fallback value as output if the input does not match the schema.
 source: /methods/fallback/fallback.ts
 contributors:
   - fabian-hiller
@@ -14,7 +15,7 @@ import { properties } from './properties';
 
 # fallback
 
-Returns a fallback output value when validating the passed schema failed.
+Returns a fallback value as output if the input does not match the schema.
 
 ```ts
 const Schema = fallback<TSchema, TFallback>(schema, fallback);
@@ -36,7 +37,7 @@ const Schema = fallback<TSchema, TFallback>(schema, fallback);
 
 > If you only want to set a default value for `null` or `undefined` inputs, you should use <Link href="../optional/">`optional`</Link>, <Link href="../nullable/">`nullable`</Link> or <Link href="../nullish/">`nullish`</Link> instead.
 
-> Warning: The fallback value is not validated. Make sure that the fallback value matches your schema.
+> The fallback value is not validated. Make sure that the fallback value matches your schema.
 
 ## Returns
 
@@ -51,7 +52,7 @@ The following examples show how `fallback` can be used.
 Schema that will always return a string output.
 
 ```ts
-const FallbackStringSchema = fallback(string(), "I'm the fallback!");
+const FallbackStringSchema = v.fallback(v.string(), "I'm the fallback!");
 ```
 
 ### Fallback date schema
@@ -61,7 +62,7 @@ Schema that will always return a [`Date`](https://developer.mozilla.org/en-US/do
 > By using a function as the `fallback` parameter, the schema will return a new [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) instance each time the input does not match the schema.
 
 ```ts
-const FallbackDateSchema = fallback(date(), () => new Date());
+const FallbackDateSchema = v.fallback(v.date(), () => new Date());
 ```
 
 ## Related
@@ -77,12 +78,15 @@ The following APIs can be combined with `fallback`.
     'bigint',
     'blob',
     'boolean',
+    'custom',
     'date',
     'enum_',
     'instance',
     'intersect',
     'lazy',
     'literal',
+    'looseObject',
+    'looseTuple',
     'map',
     'nan',
     'never',
@@ -94,14 +98,17 @@ The following APIs can be combined with `fallback`.
     'nullish',
     'number',
     'object',
+    'objectWithRest',
     'optional',
     'picklist',
     'record',
     'set',
-    'special',
+    'strictObject',
+    'strictTuple',
     'string',
     'symbol',
     'tuple',
+    'tupleWithRest',
     'undefined_',
     'union',
     'unknown',
@@ -114,22 +121,93 @@ The following APIs can be combined with `fallback`.
 
 <ApiList
   items={[
-    'brand',
-    'coerce',
     'getDefault',
     'getDefaults',
     'getFallback',
     'getFallbacks',
     'is',
     'keyof',
-    'merge',
     'omit',
     'parse',
     'partial',
     'pick',
+    'pipe',
     'required',
     'safeParse',
-    'transform',
     'unwrap',
   ]}
 />
+
+### Actions
+
+<ApiList
+  items={[
+    'bic',
+    'brand',
+    'bytes',
+    'check',
+    'creditCard',
+    'cuid2',
+    'decimal',
+    'email',
+    'emoji',
+    'empty',
+    'endsWith',
+    'every',
+    'excludes',
+    'finite',
+    'hash',
+    'hexadecimal',
+    'hexColor',
+    'imei',
+    'includes',
+    'integer',
+    'ip',
+    'ipv4',
+    'ipv6',
+    'isoDate',
+    'isoDateTime',
+    'isoTime',
+    'isoTimeSecond',
+    'isoTimestamp',
+    'isoWeek',
+    'length',
+    'mac',
+    'mac48',
+    'mac64',
+    'maxBytes',
+    'maxLength',
+    'maxSize',
+    'maxValue',
+    'mimeType',
+    'minBytes',
+    'minLength',
+    'minSize',
+    'minValue',
+    'multipleOf',
+    'nonEmpty',
+    'notBytes',
+    'notLength',
+    'notSize',
+    'notValue',
+    'octal',
+    'readonly',
+    'regex',
+    'safeInteger',
+    'size',
+    'some',
+    'startsWith',
+    'toLowerCase',
+    'toMaxValue',
+    'toMinValue',
+    'toUpperCase',
+    'transform',
+    'trim',
+    'trimEnd',
+    'trimStart',
+    'ulid',
+    'url',
+    'uuid',
+    'value',
+  ]}
+/>
diff --git a/website/src/routes/api/(methods)/fallback/properties.ts b/website/src/routes/api/(methods)/fallback/properties.ts
@@ -25,6 +25,12 @@ export const properties: Record<string, PropertyProps> = {
       type: 'custom',
       name: 'Fallback',
       href: '../Fallback/',
+      generics: [
+        {
+          type: 'custom',
+          name: 'TSchema',
+        },
+      ],
     },
   },
   schema: {

diff --git a/website/src/routes/api/(methods)/flatten/index.mdx b/website/src/routes/api/(methods)/flatten/index.mdx
@@ -1,10 +1,10 @@
 ---
 title: flatten
-source: /error/flatten/flatten.ts
+source: /methods/flatten/flatten.ts
 contributors:
   - fabian-hiller
 ---
 
 # flatten
 
-> The content of this page is not yet ready. Until then, please use the [source code](https://github.com/fabian-hiller/valibot/blob/main/library/src/error/flatten/flatten.ts) or take a look at [issue #287](https://github.com/fabian-hiller/valibot/issues/287) to help us extend the API reference.
+> The content of this page is not yet ready. Until then, please use the [source code](https://github.com/fabian-hiller/valibot/blob/main/library/src/methods/flatten/flatten.ts) or take a look at [issue #287](https://github.com/fabian-hiller/valibot/issues/287) to help us extend the API reference.
diff --git a/website/src/routes/api/(methods)/forward/index.mdx b/website/src/routes/api/(methods)/forward/index.mdx
@@ -14,25 +14,26 @@ import { properties } from './properties';
 Forwards the issues of the passed validation action.
 
 ```ts
-const Validation = forward<TInput>(validation, pathList);
+const Action = forward<TInput, TIssue>(action, pathList);
 ```
 
 ## Generics
 
 - `TInput` <Property {...properties.TInput} />
+- `TIssue` <Property {...properties.TIssue} />
 
 ## Parameters
 
-- `validation` <Property {...properties.validation} />
+- `action` <Property {...properties.action} />
 - `pathList` <Property {...properties.pathList} />
 
 ### 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 a `pathList` to a nested field of a schema.
 
 ## Returns
 
-- `Validation` <Property {...properties.Validation} />
+- `Action` <Property {...properties.Action} />
 
 ## Examples
 
@@ -43,23 +44,22 @@ The following examples show how `forward` can be used.
 Schema that ensures that the two passwords match.
 
 ```ts
-const PasswordSchema = object(
-  {
-    password1: string([
-      minLength(1, 'Please enter your password.'),
-      minLength(8, 'Your password must have 8 characters or more.'),
-    ]),
-    password2: string(),
-  },
-  [
-    forward(
-      custom(
-        (input) => input.password1 === input.password2,
-        'The two passwords do not match.'
-      ),
-      ['password2']
+const PasswordSchema = v.pipe(
+  v.object({
+    password1: v.pipe(
+      v.string(),
+      v.minLength(1, 'Please enter your password.'),
+      v.minLength(8, 'Your password must have 8 characters or more.')
     ),
-  ]
+    password2: v.string(),
+  }),
+  v.forward(
+    v.check(
+      (input) => input.password1 === input.password2,
+      'The two passwords do not match.'
+    ),
+    ['password2']
+  )
 );
 ```
 
@@ -73,10 +73,16 @@ The following APIs can be combined with `forward`.
   items={[
     'any',
     'array',
+    'custom',
+    'looseObject',
+    'looseTuple',
     'object',
+    'objectWithRest',
     'record',
-    'special',
+    'strictObject',
+    'strictTuple',
     'tuple',
+    'tupleWithRest',
     'union',
     'unknown',
     'variant',
@@ -85,21 +91,21 @@ The following APIs can be combined with `forward`.
 
 ### Methods
 
-<ApiList
-  items={['merge', 'omit', 'partial', 'pick', 'required', 'transform']}
-/>
+<ApiList items={['omit', 'partial', 'pick', 'required']} />
 
-### Validations
+### Actions
 
 <ApiList
   items={[
     'check',
+    'empty',
     'every',
     'excludes',
     'includes',
     'length',
     'maxLength',
     'minLength',
+    'nonEmpty',
     'notLength',
     'some',
   ]}