VDL Plugin SDK

TypeRef

Import from @varavel/vdl-plugin-sdk.

type TypeRef = object;

Normalized type reference used by fields.

kind selects which payload fields are meaningful. Generators should inspect kind first, then read the related payload fields.

Properties

PropertyTypeDescription
arrayDims?numberArray rank when kind is array (for example, 2 for T[][])
arrayType?TypeRefElement type when kind is array
enumName?stringReferenced enum name when kind is enum
enumType?EnumValueTypeReferenced enum underlying kind when kind is enum
kindTypeKindType category discriminator
mapType?TypeRefMap value type when kind is map
objectFields?Field[]Inline object fields when kind is object
primitiveName?PrimitiveTypePrimitive type name when kind is primitive
typeName?stringReferenced type name when kind is type