/src/typebox.ts | typebox_deno@0.31.22

import * as typeboxDeno from "https://deno.land/x/typebox_deno@0.31.22/src/typebox.ts";

Namespaces

N ExtendsUndefined	Fast undefined check used for properties of type undefined
N FormatRegistry	A registry for user defined string formats
N IndexedAccessor
N Intrinsic
N KeyArrayResolver
N KeyResolver
N ObjectMap
N TemplateLiteralDslParser
N TemplateLiteralFinite
N TemplateLiteralGenerator
N TemplateLiteralParser
N TemplateLiteralPattern
N TemplateLiteralResolver
N TypeClone	Specialized Clone for Types
N TypeExtends
N TypeGuard	Provides functions to test if JavaScript values are TypeBox types
N TypeRegistry	A registry for user defined types
N UnionResolver
N ValueGuard	Provides functions to type guard raw JavaScript values

Classes

c JavaScriptTypeBuilder
c JsonTypeBuilder
c KeyArrayResolverError
c TemplateLiteralFiniteError
c TemplateLiteralGeneratorError
c TemplateLiteralParserError
c TemplateLiteralPatternError
c TransformDecodeBuilder
c TransformEncodeBuilder
c TypeBoxError
c TypeBuilder
c TypeBuilderError
c TypeExtendsError
c TypeGuardUnknownTypeError

Enums

TypeExtendsResult

Variables

v Hint
v JsonType	Json Type Builder with Static Resolution for TypeScript
v Kind
v Optional
v PatternBoolean
v PatternBooleanExact
v PatternNumber
v PatternNumberExact
v PatternString
v PatternStringExact
v Readonly
v Transform
v Type	JavaScript Type Builder with Static Resolution for TypeScript

Functions

f ExtendsUndefined.Check
f FormatRegistry.Clear	Clears all user defined string formats
f FormatRegistry.Delete	Deletes a registered format
f FormatRegistry.Entries	Returns the entries in this registry
f FormatRegistry.Get	Gets a validation function for a user defined string format
f FormatRegistry.Has	Returns true if the user defined string format exists
f FormatRegistry.Set	Sets a validation function for a user defined string format
f IndexedAccessor.Resolve
f Intrinsic.Map	Applies an intrinsic string manipulation to the given type.
f KeyArrayResolver.Resolve	Resolves an array of string[] keys from the given schema or array type.
f KeyResolver.ResolveKeys	Resolves an array of keys in this schema
f KeyResolver.ResolvePattern	Resolves a regular expression pattern matching all keys in this schema
f ObjectMap.Map
f TemplateLiteralDslParser.Parse
f TemplateLiteralFinite.Check
f TemplateLiteralGenerator.Generate
f TemplateLiteralParser.Parse	Parses a pattern and returns an expression tree
f TemplateLiteralParser.ParseExact	Parses a pattern and strips forward and trailing ^ and $
f TemplateLiteralPattern.Create
f TemplateLiteralResolver.Resolve	Resolves a template literal as a TUnion
f TypeClone.Rest	Clones a Rest
f TypeClone.Type	Clones a Type
f TypeExtends.Extends
f TypeGuard.TAny	Returns true if the given value is TAny
f TypeGuard.TArray	Returns true if the given value is TArray
f TypeGuard.TAsyncIterator	Returns true if the given value is TAsyncIterator
f TypeGuard.TBigInt	Returns true if the given value is TBigInt
f TypeGuard.TBoolean	Returns true if the given value is TBoolean
f TypeGuard.TConstructor	Returns true if the given value is TConstructor
f TypeGuard.TDate	Returns true if the given value is TDate
f TypeGuard.TFunction	Returns true if the given value is TFunction
f TypeGuard.TInteger	Returns true if the given value is TInteger
f TypeGuard.TIntersect	Returns true if the given value is TIntersect
f TypeGuard.TIterator	Returns true if the given value is TIterator
f TypeGuard.TKind	Returns true if the given value is TKind
f TypeGuard.TKindOf	Returns true if the given value is a TKind with the given name.
f TypeGuard.TLiteral	Returns true if the given value is TLiteral
f TypeGuard.TLiteralBoolean	Returns true if the given value is TLiteral
f TypeGuard.TLiteralNumber	Returns true if the given value is TLiteral
f TypeGuard.TLiteralString	Returns true if the given value is TLiteral
f TypeGuard.TNever	Returns true if the given value is TNever
f TypeGuard.TNot	Returns true if the given value is TNot
f TypeGuard.TNull	Returns true if the given value is TNull
f TypeGuard.TNumber	Returns true if the given value is TNumber
f TypeGuard.TObject	Returns true if the given value is TObject
f TypeGuard.TOptional	Returns true if this value has a Optional symbol
f TypeGuard.TPromise	Returns true if the given value is TPromise
f TypeGuard.TReadonly	Returns true if this value has a Readonly symbol
f TypeGuard.TRecord	Returns true if the given value is TRecord
f TypeGuard.TRecursive	Returns true if this value is TRecursive
f TypeGuard.TRef	Returns true if the given value is TRef
f TypeGuard.TSchema	Returns true if the given value is TSchema
f TypeGuard.TString	Returns true if the given value is TString
f TypeGuard.TSymbol	Returns true if the given value is TSymbol
f TypeGuard.TTemplateLiteral	Returns true if the given value is TTemplateLiteral
f TypeGuard.TThis	Returns true if the given value is TThis
f TypeGuard.TTransform	Returns true of this value is TTransform
f TypeGuard.TTuple	Returns true if the given value is TTuple
f TypeGuard.TUint8Array	Returns true if the given value is TUint8Array
f TypeGuard.TUndefined	Returns true if the given value is TUndefined
f TypeGuard.TUnion	Returns true if the given value is TUnion
f TypeGuard.TUnionLiteral	Returns true if the given value is TUnion<Literal<string \| number>[]>
f TypeGuard.TUnknown	Returns true if the given value is TUnknown
f TypeGuard.TUnsafe	Returns true if the given value is a raw TUnsafe
f TypeGuard.TVoid	Returns true if the given value is TVoid
f TypeRegistry.Clear	Clears all user defined types
f TypeRegistry.Delete	Deletes a registered type
f TypeRegistry.Entries	Returns the entries in this registry
f TypeRegistry.Get	Gets a custom validation function for a user defined type
f TypeRegistry.Has	Returns true if this registry contains this kind
f TypeRegistry.Set	Sets a validation function for a user defined type
f UnionResolver.Resolve	Returns a resolved union with interior unions flattened
f ValueGuard.IsArray	Returns true if this value is an array
f ValueGuard.IsBigInt	Returns true if this value is bigint
f ValueGuard.IsBoolean	Returns true if this value is a boolean
f ValueGuard.IsNull	Returns true if this value is null
f ValueGuard.IsNumber	Returns true if this value is number
f ValueGuard.IsObject	Returns true if this value is an object
f ValueGuard.IsString	Returns true if this value is string
f ValueGuard.IsUndefined	Returns true if this value is undefined

Interfaces

I ArrayOptions
I DateOptions
I IntersectOptions
I KeyResolverOptions
I NumericOptions
I ObjectOptions
I SchemaOptions
I StringOptions
I TAny
I TArray
I TAsyncIterator
I TBigInt
I TBoolean
I TConstructor
I TDate
I TEnum
I TFunction
I TInteger
I TIntersect
I TIterator
I TKind
I TLiteral
I TNever
I TNot
I TNull
I TNumber
I TObject
I TPromise
I TransformOptions
I TRecord
I TRecursive
I TRef
I TSchema
I TString
I TSymbol
I TTemplateLiteral
I TThis
I TTransform
I TTuple
I TUint8Array
I TUndefined
I TUnion
I TUnknown
I TUnsafe
I TVoid
I Uint8ArrayOptions
I UnsafeOptions

Type Aliases

T Assert
T AssertProperties
T AssertRest
T AssertType
T DecodeProperties
T DecodeRest
T DecodeType
T Discard
T Ensure
T Evaluate
T Flat
T FormatRegistryValidationFunction
T IntersectOptional
T IntersectResolve
T IntersectType
T IsTemplateLiteralFinite
T IsTemplateLiteralFiniteArray
T IsTemplateLiteralFiniteCheck
T ObjectProperties
T ObjectPropertyKeys
T OptionalPropertyKeys
T OptionalUnwrapRest
T OptionalUnwrapType
T PropertiesReduce
T PropertiesReducer
T ReadonlyOptionalPropertyKeys
T ReadonlyPropertyKeys
T ReadonlyUnwrapRest
T ReadonlyUnwrapType
T RequiredPropertyKeys
T Static	Creates the static type for a TypeBox type
T StaticDecode	Creates the decoded static form for a TypeBox type
T StaticEncode	Creates the encoded static form for a TypeBox type
T StringContentEncodingOption
T StringFormatOption
T SymbolValue
T TAdditionalProperties
T TAnySchema
T TAwaited
T TAwaitedRest
T TComposite
T TCompositeIndex
T TCompositeKeys
T TCompositeReduce
T TConstructorParameterArray
T TConstructorParameters
T TemplateLiteralParser.And
T TemplateLiteralParser.Const
T TemplateLiteralParser.Expression
T TemplateLiteralParser.Or
T TEnumKey
T TEnumRecord
T TEnumValue
T TExclude
T TExcludeArray
T TExcludeTemplateLiteral
T TExcludeTemplateLiteralResult
T TExtends
T TExtract
T TExtractArray
T TExtractTemplateLiteral
T TExtractTemplateLiteralResult
T TFunctionParameters
T TIndex
T TIndexProperty
T TIndexRest
T TIndexRestMany
T TIndexTuple
T TIndexType
T TInstanceType
T TIntrinsic
T TIntrinsicLiteral
T TIntrinsicMode
T TIntrinsicRest
T TIntrinsicTemplateLiteral
T TKeyOf
T TKeyOfIndices
T TKeyOfIndicesArray
T TKeyOfProperties
T TLiteralBoolean
T TLiteralNumber
T TLiteralString
T TLiteralUnionReduce
T TLiteralValue
T TOmit
T TOmitProperties
T TOmitRest
T TOptional
T TParameters
T TPartial
T TPartialObjectArray
T TPartialProperties
T TPartialRest
T TPick
T TPickProperties
T TPickRest
T TProperties
T TPropertyKey
T TransformFunction
T TReadonly
T TReadonlyOptional
T TRecordFromEnumKey
T TRecordFromIntegerKey
T TRecordFromLiteralNumberKey
T TRecordFromLiteralStringKey
T TRecordFromNumberKey
T TRecordFromStringKey
T TRecordFromTemplateLiteralKey
T TRecordFromTemplateLiteralKeyFinite
T TRecordFromTemplateLiteralKeyInfinite
T TRecordFromUnion
T TRecordFromUnionLiteralNumber
T TRecordFromUnionLiteralString
T TRecordFromUnionRest
T TRecordResolve
T TRecursiveReduce
T TRequired
T TRequiredProperties
T TRequiredRest
T TRest
T TReturnType
T Trim
T TTemplateLiteralConst
T TTemplateLiteralDslParser
T TTemplateLiteralDslParserTemplate
T TTemplateLiteralDslParserTerminal
T TTemplateLiteralDslParserUnion
T TTemplateLiteralDslParserUnionLiteral
T TTemplateLiteralKeyRest
T TTemplateLiteralKind
T TTemplateLiteralUnion
T TTransformResolve
T TTupleRest
T TUnevaluatedProperties
T TUnionLiteralKeyRest
T TUnionTemplateLiteral
T TupleToIntersect
T TupleToUnion
T TypeRegistryValidationFunction
T UnionLast
T UnionOptional
T UnionResolve
T UnionToIntersect
T UnionToTuple
T UnionType