Skip to content

Commit 311e51b

Browse files
committed
chore: adjust readme
1 parent 32f062b commit 311e51b

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pnpm add @stacksjs/ts-validation
4242
import { v } from '@stacksjs/ts-validation'
4343

4444
// Create a validator for a user object
45-
const userValidator = v.object().shape({
45+
const userValidator = v.object({
4646
name: v.string().min(2).max(50).required(),
4747
email: v.string().email().required(),
4848
age: v.number().min(18).integer().required(),
@@ -127,14 +127,15 @@ const coordinatesValidator = v.array().length(2).each(v.number()).required()
127127

128128
```typescript
129129
// Object validation
130-
const addressValidator = v.object().shape({
130+
const addressValidator = v.object({
131131
street: v.string().required(),
132132
city: v.string().required(),
133133
state: v.string().length(2).required(),
134134
zip: v.string().matches(/^\d{5}$/).required(),
135135
})
136136

137137
// Nested object validation
138+
// .shape() is an alias for .object()
138139
const userValidator = v.object().shape({
139140
name: v.string().required(),
140141
address: addressValidator,

0 commit comments

Comments
 (0)