typeDef

Import from @varavel/vdl-plugin-sdk/testing.

function typeDef(
   name, 
   typeRef, 
   overrides?): TypeDef;

Creates a TypeDef with the given name and underlying type.

Pass overrides to set annotations or doc.

Parameters

Parameter	Type	Description
name	string	Type definition name.
typeRef	TypeRef	Underlying type reference.
overrides	Partial\<Omit\<TypeDef, "position" | "name" | "annotations" | "typeRef">> & object	Optional typedef overrides.

Returns

TypeDef

A TypeDef with defaults applied.

Example

typeDef("UserId", primitiveType("string"));
// returns a typedef named "UserId"