[Json]
Creates an Any type
Optional
options: SchemaOptions[JavaScript]
Creates a AsyncIterator type
Optional
options: SchemaOptions[JavaScript]
Creates a BigInt type
Optional
options: BigIntOptions[Json]
Creates a Boolean type
Optional
options: SchemaOptions[Json]
Intrinsic function to Capitalize LiteralString types
Optional
options: SchemaOptions[Json]
Creates a Composite object type
Optional
options: ObjectOptions[JavaScript]
Creates a Constructor type
Optional
options: SchemaOptions[JavaScript]
Extracts the ConstructorParameters from the given Constructor type
Optional
options: SchemaOptions[JavaScript]
Creates a Date type
Optional
options: DateOptions[Json]
Creates a Enum type
Optional
options: SchemaOptions[Json]
Constructs a type by excluding from unionType all union members that are assignable to excludedMembers
Optional
options: SchemaOptions[Json]
Constructs a type by excluding from unionType all union members that are assignable to excludedMembers
Optional
options: SchemaOptions[Json]
Constructs a type by excluding from unionType all union members that are assignable to excludedMembers
Optional
options: SchemaOptions[Json]
Creates a Conditional type
Optional
options: SchemaOptions[Json]
Creates a Conditional type
Optional
options: SchemaOptions[Json]
Creates a Conditional type
Optional
options: SchemaOptions[Json]
Constructs a type by extracting from type all union members that are assignable to union
Optional
options: SchemaOptions[Json]
Constructs a type by extracting from type all union members that are assignable to union
Optional
options: SchemaOptions[Json]
Constructs a type by extracting from type all union members that are assignable to union
Optional
options: SchemaOptions[JavaScript]
Creates a Function type
Optional
options: SchemaOptions[Json]
Returns an Indexed property type for the given keys
Optional
options: SchemaOptions[Json]
Returns an Indexed property type for the given keys
Optional
options: SchemaOptions[Json]
Returns an Indexed property type for the given keys
Optional
options: SchemaOptions[Json]
Returns an Indexed property type for the given keys
Optional
options: SchemaOptions[Json]
Returns an Indexed property type for the given keys
Optional
options: SchemaOptions[Json]
Returns an Indexed property type for the given keys
Optional
options: SchemaOptions[Json]
Returns an Indexed property type for the given keys
Optional
options: SchemaOptions[JavaScript]
Extracts the InstanceType from the given Constructor type
Optional
options: SchemaOptions[JavaScript]
Instantiates a type with the given parameters
[Json]
Creates an Integer type
Optional
options: IntegerOptions[Json]
Creates a Literal type
Optional
options: SchemaOptions[Json]
Intrinsic function to Lowercase LiteralString types
Optional
options: SchemaOptions[Json]
Creates a Mapped object type
Optional
options: ObjectOptions[Json]
Creates a Mapped object type
Optional
options: ObjectOptions[Json]
Creates a Type Definition Module.
[Json]
Creates a Never type
Optional
options: SchemaOptions[Json]
Creates a Null type
Optional
options: SchemaOptions[Json]
Creates a Number type
Optional
options: NumberOptions[Json]
Creates an Object type
Optional
options: ObjectOptions[Json]
Constructs a type whose keys are picked from the given type
Optional
options: SchemaOptions[Json]
Constructs a type whose keys are picked from the given type
Optional
options: SchemaOptions[Json]
Creates a Optional property
[Json]
Creates a Optional property
[Json]
Creates a Optional property
[Json]
Creates a Optional property
[JavaScript]
Extracts the Parameters from the given Function type
Optional
options: SchemaOptions[Json]
Constructs a type where all properties are optional
Optional
options: SchemaOptions[Json]
Constructs a type where all properties are optional
Optional
options: SchemaOptions[Json]
Constructs a type whose keys are picked from the given type
Optional
options: SchemaOptions[Json]
Constructs a type whose keys are picked from the given type
Optional
options: SchemaOptions[Json]
Creates a Readonly property
[Json]
Creates a Readonly property
[Json]
Creates a Optional property
[Json]
Creates a Readonly property
[Json]
Creates a Readonly and Optional property
[Json]
Creates a Record type
Optional
options: ObjectOptions[Json]
Creates a Recursive type
[Json]
Creates a Ref type.
Optional
options: SchemaOptionsOptional
options: SchemaOptions[Json]
Creates a Ref type. This signature was deprecated in 0.34.0 where Ref requires callers to pass
a string
value for the reference (and not a schema).
To adhere to the 0.34.0 signature, Ref implementations should be updated to the following.
// pre-0.34.0
const T = Type.String({ $id: 'T' })
const R = Type.Ref(T)
should be changed to the following
// post-0.34.0
const T = Type.String({ $id: 'T' })
const R = Type.Unsafe<Static<typeof T>>(Type.Ref('T'))
You can also create a generic function to replicate the pre-0.34.0 signature if required
const LegacyRef = <T extends TSchema>(schema: T) => Type.Unsafe<Static<T>>(Type.Ref(schema.$id!))
[JavaScript]
Creates a RegExp type
Optional
options: RegExpOptions[JavaScript]
Creates a RegExp type
Optional
options: RegExpOptions[Json]
Constructs a type where all properties are required
Optional
options: SchemaOptions[Json]
Constructs a type where all properties are required
Optional
options: SchemaOptions[JavaScript]
Extracts the ReturnType from the given Function type
Optional
options: SchemaOptions[Json]
Creates a String type
Optional
options: StringOptions[JavaScript]
Creates a Symbol type
Optional
options: SchemaOptions[Json]
Creates a TemplateLiteral type from template dsl string
Optional
options: SchemaOptions[Json]
Creates a TemplateLiteral type
Optional
options: SchemaOptions[Json]
Creates a Transform type
[JavaScript]
Creates a Uint8Array type
Optional
options: Uint8ArrayOptions[Json]
Intrinsic function to Uncapitalize LiteralString types
Optional
options: SchemaOptions[JavaScript]
Creates a Undefined type
Optional
options: SchemaOptions[Json]
Creates an Unknown type
Optional
options: SchemaOptions[Json]
Intrinsic function to Uppercase LiteralString types
Optional
options: SchemaOptions[JavaScript]
Creates a Void type
Optional
options: SchemaOptions
JavaScript Type Builder with Static Resolution for TypeScript