From 7f64a37d02d47175e2f0d07b199f8b81d9c05c71 Mon Sep 17 00:00:00 2001 From: sinclair Date: Tue, 11 Feb 2025 17:25:17 +0900 Subject: [PATCH] Documentation --- readme.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/readme.md b/readme.md index b7ceeb7..72a81ce 100644 --- a/readme.md +++ b/readme.md @@ -28,16 +28,20 @@ Parse and Compile Types from TypeScript Syntax ([Example](https://www.typescript ```typescript import { Compile } from '@sinclair/typemap' - -const validator = Compile(`{ x: number, y: number }`) // const validator: Validator> -const result = validator.Check({ // as { - x: 1, // x: number, - y: 2 // y: number -}) // } +// Validate with Standard Schema + +const result = validator['~standard'].validate({ // const result: StandardSchemaV1.Result<{ + a: 'hello', // a: string, + b: 'world' // b: string +}) // }> ``` ## Overview