TypeCodeKey (Xantham)

TypeCodeKey Type

Namespace: Xantham.Decoder
Assembly: Xantham.Decoder.dll
Parent Module: CodeKey
Base Type: ValueType
All Interfaces: IEquatable<TypeCodeKey> , IStructuralEquatable , IComparable<TypeCodeKey> , IComparable , IStructuralComparable
Kind: Struct

A TypeKey tagged with the TsType case it identifies.

Union cases

Union case	Description
`Array array` Full Usage: `Array array` Parameters: array : `TypeKey`	An array type (T[] or Array<T>). array : `TypeKey`
`Conditional conditional` Full Usage: `Conditional conditional` Parameters: conditional : `TypeKey`	A conditional type (T extends U ? X : Y). conditional : `TypeKey`
`EnumCase enumCase` Full Usage: `EnumCase enumCase` Parameters: enumCase : `TypeKey`	A single case of an enum. enumCase : `TypeKey`
`GlobalThis` Full Usage: `GlobalThis`	The synthetic globalThis reference type.
`Index index` Full Usage: `Index index` Parameters: index : `TypeKey`	A keyof index type (keyof T). index : `TypeKey`
`IndexAccess indexAccess` Full Usage: `IndexAccess indexAccess` Parameters: indexAccess : `TypeKey`	An indexed access type (T[K]). indexAccess : `TypeKey`
`Intersection intersection` Full Usage: `Intersection intersection` Parameters: intersection : `TypeKey`	An intersection type (A & B). intersection : `TypeKey`
`Literal literal` Full Usage: `Literal literal` Parameters: literal : `TypeKey`	A literal type (string, number, boolean, or bigint literal). literal : `TypeKey`
`Optional optional` Full Usage: `Optional optional` Parameters: optional : `TypeKey`	An optional type wrapper. optional : `TypeKey`
`Predicate predicate` Full Usage: `Predicate predicate` Parameters: predicate : `TypeKey`	A type predicate (x is T). predicate : `TypeKey`
`Primitive primitive` Full Usage: `Primitive primitive` Parameters: primitive : `TypeKey`	A primitive type (string, number, boolean, etc.). primitive : `TypeKey`
`ReadOnly readOnly` Full Usage: `ReadOnly readOnly` Parameters: readOnly : `TypeKey`	A readonly-modified type. readOnly : `TypeKey`
`Substitution substitution` Full Usage: `Substitution substitution` Parameters: substitution : `TypeKey`	A substitution type used in conditional/distributive type checking. substitution : `TypeKey`
`TemplateLiteral templateLiteral` Full Usage: `TemplateLiteral templateLiteral` Parameters: templateLiteral : `TypeKey`	A template literal type (`prefix-${T}`). templateLiteral : `TypeKey`
`Tuple tuple` Full Usage: `Tuple tuple` Parameters: tuple : `TypeKey`	A tuple type (fixed, labeled, or variadic). tuple : `TypeKey`
`TypeLiteral typeLiteral` Full Usage: `TypeLiteral typeLiteral` Parameters: typeLiteral : `TypeKey`	An anonymous type literal ({ x: number }). typeLiteral : `TypeKey`
`TypeParameter typeParameter` Full Usage: `TypeParameter typeParameter` Parameters: typeParameter : `TypeKey`	A type parameter binding (T). typeParameter : `TypeKey`
`TypeQuery typeQuery` Full Usage: `TypeQuery typeQuery` Parameters: typeQuery : `TypeKey`	A type query (`typeof T`). typeQuery : `TypeKey`
`TypeReference typeReference` Full Usage: `TypeReference typeReference` Parameters: typeReference : `TypeKey`	A reference to another type (named, with optional type arguments). typeReference : `TypeKey`
`Union union` Full Usage: `Union union` Parameters: union : `TypeKey`	A union type (A \| B). union : `TypeKey`

Instance members

Instance member	Description
`this.IsArray` Full Usage: `this.IsArray` Returns: `bool`	Returns: `bool`
`this.IsConditional` Full Usage: `this.IsConditional` Returns: `bool`	Returns: `bool`
`this.IsEnumCase` Full Usage: `this.IsEnumCase` Returns: `bool`	Returns: `bool`
`this.IsGlobalThis` Full Usage: `this.IsGlobalThis` Returns: `bool`	Returns: `bool`
`this.IsIndex` Full Usage: `this.IsIndex` Returns: `bool`	Returns: `bool`
`this.IsIndexAccess` Full Usage: `this.IsIndexAccess` Returns: `bool`	Returns: `bool`
`this.IsIntersection` Full Usage: `this.IsIntersection` Returns: `bool`	Returns: `bool`
`this.IsLiteral` Full Usage: `this.IsLiteral` Returns: `bool`	Returns: `bool`
`this.IsOptional` Full Usage: `this.IsOptional` Returns: `bool`	Returns: `bool`
`this.IsPredicate` Full Usage: `this.IsPredicate` Returns: `bool`	Returns: `bool`
`this.IsPrimitive` Full Usage: `this.IsPrimitive` Returns: `bool`	Returns: `bool`
`this.IsReadOnly` Full Usage: `this.IsReadOnly` Returns: `bool`	Returns: `bool`
`this.IsSubstitution` Full Usage: `this.IsSubstitution` Returns: `bool`	Returns: `bool`
`this.IsTemplateLiteral` Full Usage: `this.IsTemplateLiteral` Returns: `bool`	Returns: `bool`
`this.IsTuple` Full Usage: `this.IsTuple` Returns: `bool`	Returns: `bool`
`this.IsTypeLiteral` Full Usage: `this.IsTypeLiteral` Returns: `bool`	Returns: `bool`
`this.IsTypeParameter` Full Usage: `this.IsTypeParameter` Returns: `bool`	Returns: `bool`
`this.IsTypeQuery` Full Usage: `this.IsTypeQuery` Returns: `bool`	Returns: `bool`
`this.IsTypeReference` Full Usage: `this.IsTypeReference` Returns: `bool`	Returns: `bool`
`this.IsUnion` Full Usage: `this.IsUnion` Returns: `bool`	Returns: `bool`