Skip to content

Commit 0f0c632

Browse files
authored
Streamline coerce documentation (#37)
1 parent 546cf77 commit 0f0c632

2 files changed

Lines changed: 2 additions & 11 deletions

File tree

README.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -69,16 +69,7 @@ That's it! Conformal automatically handles FormData parsing, type coercion, and
6969
- **[`serialize`](src/README.md#serialize)** - Transform typed values back to form-compatible strings
7070
- **[`getPath`](src/README.md#getpath)** - Safely access nested values using dot/bracket notation
7171
- **[`setPath`](src/README.md#setpath)** - Immutably set nested values using dot/bracket notation
72-
73-
### Coerce Functions
74-
75-
- **[`coerceString`](src/README.md#coercestring)** - String handling
76-
- **[`coerceFile`](src/README.md#coercefile)** - File handling
77-
- **[`coerceNumber`](src/README.md#coercenumber)** - String to number coercion
78-
- **[`coerceBigint`](src/README.md#coercebigint)** - String to BigInt coercion
79-
- **[`coerceBoolean`](src/README.md#coerceboolean)** - String to boolean coercion
80-
- **[`coerceDate`](src/README.md#coercedate)** - String to Date coercion
81-
- **[`coerceArray`](src/README.md#coercearray)** - Coerce to array
72+
- **[`coerceX`](src/README.md#coerce-functions)** - A set of coercion functions for building custom schemas
8273

8374
### Types
8475

src/valibot/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The Valibot Utilities are provided under the `conformal/valibot` subpath. Valibo
66

77
## Field Schemas
88

9-
Conformal's field schemas are preprocessing wrappers that handle common form input patterns automatically. They convert empty strings to `undefined`, coerce string inputs to appropriate types (numbers, dates, booleans), and handle `File` objects. They're fully compatible with Valibot and can be mixed with regular Valibot schemas.
9+
These field schemas are preprocessing wrappers that handle common form input patterns automatically by using conformal's set of coerce functions internally. They convert empty strings to `undefined`, coerce string inputs to appropriate types (numbers, dates, booleans), and handle `File` objects. They're fully compatible with Valibot and can be mixed with regular Valibot schemas.
1010

1111
```typescript
1212
import * as vf from "conformal/valibot";

0 commit comments

Comments
 (0)