Support Optional and Readonly Function Arguments

sinclairzx81 · Apr 20, 2024 · c46dfbf · c46dfbf
1 parent 1de3543
commit c46dfbf
Show file tree

Hide file tree

Showing 5 changed files with 80 additions and 10 deletions.
diff --git a/example/index.ts b/example/index.ts
@@ -3,10 +3,38 @@ import { TypeCompiler } from '@sinclair/typebox/compiler'
 import { Value, ValuePointer } from '@sinclair/typebox/value'
 import { Type, TypeGuard, Kind, Static, TSchema } from '@sinclair/typebox'
 
-const F = Type.Constructor([Type.Readonly(Type.Array(Type.String()))], Type.Number())
+// -----------------------------------------------------------
+// Create: Type
+// -----------------------------------------------------------
 
-console.log(F)
+const T = Type.Object({
+  x: Type.Number(),
+  y: Type.Number(),
+  z: Type.Number(),
+})
 
-type X = Static<typeof F>
+type T = Static<typeof T>
 
-type A = (x: readonly number[]) => void
+console.log(T)
+
+// -----------------------------------------------------------
+// Create: Value
+// -----------------------------------------------------------
+
+const V = Value.Create(T)
+
+console.log(V)
+
+// -----------------------------------------------------------
+// Compile: Type
+// -----------------------------------------------------------
+
+const C = TypeCompiler.Compile(T)
+
+console.log(C.Code())
+
+// -----------------------------------------------------------
+// Check: Value
+// -----------------------------------------------------------
+
+console.log(C.Check(V))
diff --git a/src/type/constructor/constructor.ts b/src/type/constructor/constructor.ts
@@ -29,8 +29,8 @@ THE SOFTWARE.
 import type { TSchema, SchemaOptions } from '../schema/index'
 import type { Static } from '../static/index'
 import type { Ensure } from '../helpers/index'
-import type { TReadonlyOptional } from '../readonly-optional'
-import type { TReadonly } from '../readonly'
+import type { TReadonlyOptional } from '../readonly-optional/index'
+import type { TReadonly } from '../readonly/index'
 import type { TOptional } from '../optional/index'
 import { CloneType, CloneRest } from '../clone/type'
 import { Kind } from '../symbols/index'
@@ -43,7 +43,7 @@ type StaticReturnType<U extends TSchema, P extends unknown[]> = Static<U, P>
 type StaticParameter<T extends TSchema, P extends unknown[]> =
   T extends TReadonlyOptional<T> ? [Readonly<Static<T, P>>?] :
   T extends TReadonly<T> ? [Readonly<Static<T, P>>] :
-  T extends TOptional<T> ? [Static<T, P>] :
+  T extends TOptional<T> ? [Static<T, P>?] :
   [Static<T, P>]
 // prettier-ignore
 type StaticParameters<T extends TSchema[], P extends unknown[], Acc extends unknown[] = []> = (

diff --git a/src/type/function/function.ts b/src/type/function/function.ts
@@ -29,8 +29,8 @@ THE SOFTWARE.
 import type { TSchema, SchemaOptions } from '../schema/index'
 import type { Static } from '../static/index'
 import type { Ensure } from '../helpers/index'
-import type { TReadonlyOptional } from '../readonly-optional'
-import type { TReadonly } from '../readonly'
+import type { TReadonlyOptional } from '../readonly-optional/index'
+import type { TReadonly } from '../readonly/index'
 import type { TOptional } from '../optional/index'
 import { CloneType, CloneRest } from '../clone/type'
 import { Kind } from '../symbols/index'
@@ -43,7 +43,7 @@ type StaticReturnType<U extends TSchema, P extends unknown[]> = Static<U, P>
 type StaticParameter<T extends TSchema, P extends unknown[]> =
   T extends TReadonlyOptional<T> ? [Readonly<Static<T, P>>?] :
   T extends TReadonly<T> ? [Readonly<Static<T, P>>] :
-  T extends TOptional<T> ? [Static<T, P>] :
+  T extends TOptional<T> ? [Static<T, P>?] :
   [Static<T, P>]
 // prettier-ignore
 type StaticParameters<T extends TSchema[], P extends unknown[], Acc extends unknown[] = []> = (

diff --git a/test/static/constructor.ts b/test/static/constructor.ts
@@ -13,6 +13,26 @@ import { Type } from '@sinclair/typebox'
   }))
   Expect(T).ToStatic<new (param_0: number, param_1: string) => { method: new (param_0: number, param_1: string) => boolean }>()
 }
+{
+  // readonly-optional
+  const T = Type.Constructor([Type.ReadonlyOptional(Type.Array(Type.Number()))], Type.Number())
+  Expect(T).ToStaticDecode<new (param_0?: readonly number[]) => number>()
+}
+{
+  // readonly
+  const T = Type.Constructor([Type.Readonly(Type.Array(Type.Number()))], Type.Number())
+  Expect(T).ToStaticDecode<new (param_0: readonly number[]) => number>()
+}
+{
+  // optional 1
+  const T = Type.Constructor([Type.Optional(Type.Number())], Type.Number())
+  Expect(T).ToStaticDecode<new (param_0?: number) => number>()
+}
+{
+  // optional 2
+  const T = Type.Constructor([Type.Number(), Type.Optional(Type.Number())], Type.Number())
+  Expect(T).ToStaticDecode<new (param_0: number, param_1?: number) => number>()
+}
 {
   // decode 2
   const S = Type.Transform(Type.Integer())

diff --git a/test/static/function.ts b/test/static/function.ts
@@ -14,6 +14,28 @@ import { Type } from '@sinclair/typebox'
   }))
   Expect(T).ToStatic<(param_0: number, param_1: string) => { method: (param_0: number, param_1: string) => boolean }>()
 }
+{
+  // readonly-optional
+  const T = Type.Function([Type.ReadonlyOptional(Type.Array(Type.Number()))], Type.Number())
+  Expect(T).ToStaticDecode<(param_0?: readonly number[]) => number>()
+}
+{
+  // readonly
+  const T = Type.Function([Type.Readonly(Type.Array(Type.Number()))], Type.Number())
+  Expect(T).ToStaticDecode<(param_0: readonly number[]) => number>()
+}
+{
+  // optional 1
+  const T = Type.Function([Type.Optional(Type.Number())], Type.Number())
+  Expect(T).ToStaticDecode<(param_0?: number) => number>()
+}
+{
+  // optional 2
+  const T = Type.Function([Type.Number(), Type.Optional(Type.Number())], Type.Number())
+  Expect(T).ToStaticDecode<(param_0: number, param_1?: number) => number>()
+}
+const F = Type.Constructor([Type.Readonly(Type.Array(Type.String()))], Type.Number())
+
 {
   // decode 2
   const S = Type.Transform(Type.Integer())