From 53c3d7547a0c31fdb67c16896155bdfb48db1b7d Mon Sep 17 00:00:00 2001 From: sinclair Date: Thu, 14 Nov 2024 00:38:04 +0900 Subject: [PATCH] Documentation --- readme.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 39fd650..3adeae9 100644 --- a/readme.md +++ b/readme.md @@ -4,7 +4,7 @@

Json Schema Type Builder with Static Type Resolution for TypeScript

- +

@@ -777,7 +777,8 @@ type T = Static // type T = string | null TypeBox Modules are containers for related types. They function as namespaces and enable internal types to reference each other via string references. Modules support both singular and mutually recursive types. They provide a mechanism to create circular types irrespective of the order in which types are defined. ```typescript -// The following creates a circular recursive type. + +// The following creates a Module of circular recursive Types. const Module = Type.Module({ A: Type.Object({ @@ -791,7 +792,7 @@ const Module = Type.Module({ }), }) -// Module types must be imported before use. +// Module Types must be imported before use. const A = Module.Import('A') // const A: TImport<{...}, 'A'>