diff --git a/readme.md b/readme.md index 0a3e3f2ef..47217e1ed 100644 --- a/readme.md +++ b/readme.md @@ -82,7 +82,7 @@ License MIT - [Rest](#types-rest) - [Transform](#types-transform) - [Intrinsic](#types-intrinsic) - - [Guard](#types-guard) + - [TypeGuard](#types-typeguard) - [Unsafe](#types-unsafe) - [Strict](#types-strict) - [Values](#values) @@ -1042,9 +1042,9 @@ const S = StringEnum(['A', 'B', 'C']) // const S = { type S = Static // type S = 'A' | 'B' | 'C' ``` - + -### Type Guard +### TypeGuard TypeBox can type check its own types with the TypeGuard module. This module is written for reflection and provides structural tests for every TypeBox type. Functions of this module return `is` guards which can be used with TypeScript control flow assertions to obtain schema inference. The following guards that the value A is TString.