VDL Plugin SDK

enumMember

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

function enumMember(
   name, 
   value, 
   overrides?
): EnumMember;

Creates an EnumMember with the given name and literal value.

Pass overrides to set annotations or doc.

Parameters

ParameterTypeDescription
namestringEnum member name.
valueLiteralValueEnum member literal value.
overrides?Partial<Omit<EnumMember, "position" | "name" | "annotations" | "value">> & objectOptional member overrides.

Returns

EnumMember

An EnumMember with defaults applied.

Example

enumMember("ADMIN", stringLiteral("admin"));
// returns an enum member named "ADMIN"