field

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

function field(
   name, 
   typeRef, 
   overrides?): Field;

Creates a Field with the given name and type.

Pass overrides to set optional, annotations, or doc.

Parameters

Parameter	Type	Description
name	string	Field name.
typeRef	TypeRef	Field type reference.
overrides	Partial\<Omit\<Field, "position" | "name" | "annotations" | "optional" | "typeRef">> & object	Optional field overrides.

Returns

Field

A Field with defaults applied.

Example

field("id", primitiveType("string"), { optional: true });
// returns a Field named "id" marked as optional